contacts

Creates, updates, deletes, gets or lists a contacts resource.

Overview

Name	contacts
Type	Resource
Id	aws.groundstation.contacts

Fields

The following fields are returned by SELECT queries:

list_contacts

Name	Datatype	Description
contact_id	string	UUID of a contact. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
contact_status	string	Status of a contact. (SCHEDULING, FAILED_TO_SCHEDULE, SCHEDULED, CANCELLED, AWS_CANCELLED, PREPASS, PASS, POSTPASS, COMPLETED, FAILED, AVAILABLE, CANCELLING, AWS_FAILED)
end_time	string (date-time)	End time of a contact in UTC.
ephemeris	object	The ephemeris that determines antenna pointing for the contact.
error_message	string	Error message of a contact.
ground_station	string	Name of a ground station.
maximum_elevation	object	Maximum elevation angle of a contact.
mission_profile_arn	string	ARN of a mission profile. (pattern: <code>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}</code>)
post_pass_end_time	string (date-time)	End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
pre_pass_start_time	string (date-time)	Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
region	string	Region of a contact.
satellite_arn	string	ARN of a satellite. (pattern: <code>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}</code>)
start_time	string (date-time)	Start time of a contact in UTC.
tags	object	Tags assigned to a contact.
version	object	Version information for a contact.
visibility_end_time	string (date-time)	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. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
visibility_start_time	string (date-time)	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. This field is not present for contacts with a SCHEDULING or SCHEDULED status.

describe_contact

Name	Datatype	Description
contact_id	string	UUID of a contact. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
contact_status	string	Status of a contact. (SCHEDULING, FAILED_TO_SCHEDULE, SCHEDULED, CANCELLED, AWS_CANCELLED, PREPASS, PASS, POSTPASS, COMPLETED, FAILED, AVAILABLE, CANCELLING, AWS_FAILED)
dataflow_list	array	List describing source and destination details for each dataflow edge.
end_time	string (date-time)	End time of a contact in UTC.
ephemeris	object	The ephemeris that determines antenna pointing directions for the contact.
error_message	string	Error message for a contact.
ground_station	string	Ground station for a contact.
maximum_elevation	object	Maximum elevation angle of a contact.
mission_profile_arn	string	ARN of a mission profile. (pattern: <code>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}</code>)
post_pass_end_time	string (date-time)	End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
pre_pass_start_time	string (date-time)	Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
region	string	Region where the ReserveContact API was called to schedule this contact.
satellite_arn	string	ARN of a satellite. (pattern: <code>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}</code>)
start_time	string (date-time)	Start time of a contact in UTC.
tags	object	Tags assigned to a contact.
tracking_overrides	object	Tracking configuration overrides specified when the contact was reserved.
version	object	Version information for a contact.
visibility_end_time	string (date-time)	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.
visibility_start_time	string (date-time)	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_contacts	select	region		Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
describe_contact	select	contact_id, region		Describes an existing contact.
update_contact	update	contact_id, region		Updates a specific contact.
cancel_contact	exec	contact_id, region		Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle. For contacts that: Have yet to start, the contact will be cancelled. Have started but have yet to finish, the contact will be stopped.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
contact_id	string	UUID of a contact.
region	string	AWS region (default: us-east-1)

SELECT examples

list_contacts

Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

SELECT
contact_id,
contact_status,
end_time,
ephemeris,
error_message,
ground_station,
maximum_elevation,
mission_profile_arn,
post_pass_end_time,
pre_pass_start_time,
region,
satellite_arn,
start_time,
tags,
version,
visibility_end_time,
visibility_start_time
FROM aws.groundstation.contacts
WHERE region = '{{ region }}' -- required
;

describe_contact

Describes an existing contact.

SELECT
contact_id,
contact_status,
dataflow_list,
end_time,
ephemeris,
error_message,
ground_station,
maximum_elevation,
mission_profile_arn,
post_pass_end_time,
pre_pass_start_time,
region,
satellite_arn,
start_time,
tags,
tracking_overrides,
version,
visibility_end_time,
visibility_start_time
FROM aws.groundstation.contacts
WHERE contact_id = '{{ contact_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_contact

Updates a specific contact.

UPDATE aws.groundstation.contacts
SET 
clientToken = '{{ clientToken }}',
trackingOverrides = '{{ trackingOverrides }}',
satelliteArn = '{{ satelliteArn }}'
WHERE 
contact_id = '{{ contact_id }}' --required
AND region = '{{ region }}' --required
RETURNING
contact_id,
version_id;

Lifecycle Methods

cancel_contact

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle. For contacts that: Have yet to start, the contact will be cancelled. Have started but have yet to finish, the contact will be stopped.

EXEC aws.groundstation.contacts.cancel_contact 
@contact_id='{{ contact_id }}' --required, 
@region='{{ region }}' --required
;