contact_versions

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

Overview

Name	contact_versions
Type	Resource
Id	aws.groundstation.contact_versions

Fields

The following fields are returned by SELECT queries:

describe_contact_version

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 the contact's 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 applied to this contact version. For the initial version, these are the overrides specified when the contact was reserved. For subsequent versions, these are the overrides associated with that specific version update.
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.

list_contact_versions

Name	Datatype	Description
activated	string (date-time)	Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
created	string (date-time)	Time the contact version was created in UTC.
failure_codes	array	List of failure codes for the contact version.
failure_message	string	Failure message for the contact version.
last_updated	string (date-time)	Time the contact version was last updated in UTC.
status	string	Status of the contact version. (UPDATING, ACTIVE, SUPERSEDED, FAILED_TO_UPDATE)
superseded	string (date-time)	Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
version_id	integer	Version ID of a contact.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_contact_version	select	contact_id, version_id, region		Describes a specific version of a contact.
list_contact_versions	select	contact_id, region	maxResults, nextToken	Returns a list of versions for a specified contact.

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)
version_id	integer	Version ID of a contact.
maxResults	integer	Maximum number of contact versions returned.
nextToken	string	Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.

SELECT examples

describe_contact_version

Describes a specific version of a 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.contact_versions
WHERE contact_id = '{{ contact_id }}' -- required
AND version_id = '{{ version_id }}' -- required
AND region = '{{ region }}' -- required
;

list_contact_versions

Returns a list of versions for a specified contact.

SELECT
activated,
created,
failure_codes,
failure_message,
last_updated,
status,
superseded,
version_id
FROM aws.groundstation.contact_versions
WHERE contact_id = '{{ contact_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;