[ aws . groundstation ]

describe-contact

Description

Describes an existing contact.

See also: AWS API Documentation

Synopsis

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

--contact-id (string) [required]

UUID of a contact.

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

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

contactId -> (string)

UUID of a contact.

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

missionProfileArn -> (string)

ARN of a mission profile.

Constraints:

• min: 89
• max: 138
• pattern: arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

satelliteArn -> (string)

ARN of a satellite.

Constraints:

• min: 82
• max: 132
• pattern: arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

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.

Possible values:

• SCHEDULING
• FAILED_TO_SCHEDULE
• SCHEDULED
• CANCELLED
• AWS_CANCELLED
• PREPASS
• PASS
• POSTPASS
• COMPLETED
• FAILED
• AVAILABLE
• CANCELLING
• AWS_FAILED

errorMessage -> (string)

Error message for a contact.

maximumElevation -> (structure)

Maximum elevation angle of a contact.

value -> (double) [required]

Elevation angle value.

unit -> (string) [required]

Elevation angle units.

Possible values:

• DEGREE_ANGLE
• RADIAN

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 .

Possible values:

• antenna-downlink
• antenna-downlink-demod-decode
• tracking
• dataflow-endpoint
• antenna-uplink
• uplink-echo
• s3-recording

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) [required]

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

(string)

securityGroupIds -> (list) [required]

The security groups to attach to the elastic network interfaces.

(string)

roleArn -> (string) [required]

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

endpoint -> (structure)

A dataflow endpoint.

name -> (string)

Name of a dataflow endpoint.

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

address -> (structure)

Socket address of a dataflow endpoint.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

status -> (string)

Status of a dataflow endpoint.

Possible values:

• created
• creating
• deleted
• deleting
• failed

mtu -> (integer)

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

Constraints:

• min: 1400
• max: 1500

awsGroundStationAgentEndpoint -> (structure)

An agent endpoint.

name -> (string) [required]

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

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

egressAddress -> (structure) [required]

The egress address of AgentEndpoint.

socketAddress -> (structure) [required]

A socket address.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

mtu -> (integer)

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

ingressAddress -> (structure) [required]

The ingress address of AgentEndpoint.

socketAddress -> (structure) [required]

A ranged socket address.

name -> (string) [required]

IPv4 socket address.

Constraints:

• min: 7
• max: 16
• pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

portRange -> (structure) [required]

Port range of a socket address.

minimum -> (integer) [required]

A minimum value.

maximum -> (integer) [required]

A maximum value.

mtu -> (integer)

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

Constraints:

• min: 1400
• max: 1500

agentStatus -> (string)

The status of AgentEndpoint.

Possible values:

• SUCCESS
• FAILED
• ACTIVE
• INACTIVE

auditResults -> (string)

The results of the audit.

Possible values:

• HEALTHY
• UNHEALTHY

healthStatus -> (string)

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

Possible values:

• HEALTHY
• UNHEALTHY

healthReasons -> (list)

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

Constraints:

• min: 0
• max: 500

(string)

Possible values:

• NO_REGISTERED_AGENT
• INVALID_IP_OWNERSHIP
• NOT_AUTHORIZED_TO_CREATE_SLR
• UNVERIFIED_IP_OWNERSHIP
• INITIALIZING_DATAPLANE
• DATAPLANE_FAILURE
• HEALTHY

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 .

Possible values:

• antenna-downlink
• antenna-downlink-demod-decode
• tracking
• dataflow-endpoint
• antenna-uplink
• uplink-echo
• s3-recording

configId -> (string)

UUID of a Config .

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

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) [required]

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

(string)

securityGroupIds -> (list) [required]

The security groups to attach to the elastic network interfaces.

(string)

roleArn -> (string) [required]

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

endpoint -> (structure)

A dataflow endpoint.

name -> (string)

Name of a dataflow endpoint.

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

address -> (structure)

Socket address of a dataflow endpoint.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

status -> (string)

Status of a dataflow endpoint.

Possible values:

• created
• creating
• deleted
• deleting
• failed

mtu -> (integer)

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

Constraints:

• min: 1400
• max: 1500

awsGroundStationAgentEndpoint -> (structure)

An agent endpoint.

name -> (string) [required]

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

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

egressAddress -> (structure) [required]

The egress address of AgentEndpoint.

socketAddress -> (structure) [required]

A socket address.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

mtu -> (integer)

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

ingressAddress -> (structure) [required]

The ingress address of AgentEndpoint.

socketAddress -> (structure) [required]

A ranged socket address.

name -> (string) [required]

IPv4 socket address.

Constraints:

• min: 7
• max: 16
• pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

portRange -> (structure) [required]

Port range of a socket address.

minimum -> (integer) [required]

A minimum value.

maximum -> (integer) [required]

A maximum value.

mtu -> (integer)

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

Constraints:

• min: 1400
• max: 1500

agentStatus -> (string)

The status of AgentEndpoint.

Possible values:

• SUCCESS
• FAILED
• ACTIVE
• INACTIVE

auditResults -> (string)

The results of the audit.

Possible values:

• HEALTHY
• UNHEALTHY

healthStatus -> (string)

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

Possible values:

• HEALTHY
• UNHEALTHY

healthReasons -> (list)

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

Constraints:

• min: 0
• max: 500

(string)

Possible values:

• NO_REGISTERED_AGENT
• INVALID_IP_OWNERSHIP
• NOT_AUTHORIZED_TO_CREATE_SLR
• UNVERIFIED_IP_OWNERSHIP
• INITIALIZING_DATAPLANE
• DATAPLANE_FAILURE
• HEALTHY

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) [required]

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) [required]

Unique identifier of the azimuth elevation ephemeris.

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

ephemeris -> (structure)

The ephemeris that determines antenna pointing directions for the contact.

ephemerisId -> (string)

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

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

ephemerisType -> (string) [required]

Type of ephemeris.

Possible values:

• TLE
• OEM
• AZ_EL
• SERVICE_MANAGED