mission_profiles

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

Overview

Name	mission_profiles
Type	Resource
Id	aws.groundstation.mission_profiles

Fields

The following fields are returned by SELECT queries:

get_mission_profile

Name	Datatype	Description
name	string	Name of a mission profile. (pattern: <code>[ a-zA-Z0-9_:-]{1,256}</code>)
contact_post_pass_duration_seconds	integer	Amount of time after a contact ends that you'd like to receive a CloudWatch event indicating the pass has finished.
contact_pre_pass_duration_seconds	integer	Amount of time prior to contact start you'd like to receive a CloudWatch event indicating an upcoming pass.
dataflow_edges	array	A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
minimum_viable_contact_duration_seconds	integer	Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
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>)
mission_profile_id	string	UUID of a mission profile. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
region	string	Region of a mission profile. (pattern: <code>[\w-]+</code>)
streams_kms_key	object	KMS key info.
streams_kms_role	string	Role to use for encrypting streams with KMS key. (pattern: <code>arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}</code>)
tags	object	Tags assigned to a mission profile.
telemetry_sink_config_arn	string	ARN of a telemetry sink Config. (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?</code>)
tracking_config_arn	string	ARN of a tracking Config. (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?</code>)

list_mission_profiles

Name	Datatype	Description
name	string	Name of a mission profile. (pattern: <code>[ a-zA-Z0-9_:-]{1,256}</code>)
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>)
mission_profile_id	string	UUID of a mission profile. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
region	string	Region of a mission profile. (pattern: <code>[\w-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_mission_profile	select	mission_profile_id, region		Returns a mission profile.
list_mission_profiles	select	region	maxResults, nextToken	Returns a list of mission profiles.
create_mission_profile	insert	region, name, minimumViableContactDurationSeconds, dataflowEdges, trackingConfigArn		Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
update_mission_profile	update	mission_profile_id, region		Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.
delete_mission_profile	delete	mission_profile_id, region		Deletes a mission profile.
reserve_contact	exec	region, missionProfileArn, startTime, endTime, groundStation		Reserves a contact using specified parameters.

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
mission_profile_id	string	UUID of a mission profile.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of mission profiles returned.
nextToken	string	Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

SELECT examples

get_mission_profile

Returns a mission profile.

SELECT
name,
contact_post_pass_duration_seconds,
contact_pre_pass_duration_seconds,
dataflow_edges,
minimum_viable_contact_duration_seconds,
mission_profile_arn,
mission_profile_id,
region,
streams_kms_key,
streams_kms_role,
tags,
telemetry_sink_config_arn,
tracking_config_arn
FROM aws.groundstation.mission_profiles
WHERE mission_profile_id = '{{ mission_profile_id }}' -- required
AND region = '{{ region }}' -- required
;

list_mission_profiles

Returns a list of mission profiles.

SELECT
name,
mission_profile_arn,
mission_profile_id,
region
FROM aws.groundstation.mission_profiles
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_mission_profile

Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.

INSERT INTO aws.groundstation.mission_profiles (
name,
contactPrePassDurationSeconds,
contactPostPassDurationSeconds,
minimumViableContactDurationSeconds,
dataflowEdges,
trackingConfigArn,
telemetrySinkConfigArn,
tags,
streamsKmsKey,
streamsKmsRole,
region
)
SELECT 
'{{ name }}' /* required */,
{{ contactPrePassDurationSeconds }},
{{ contactPostPassDurationSeconds }},
{{ minimumViableContactDurationSeconds }} /* required */,
'{{ dataflowEdges }}' /* required */,
'{{ trackingConfigArn }}' /* required */,
'{{ telemetrySinkConfigArn }}',
'{{ tags }}',
'{{ streamsKmsKey }}',
'{{ streamsKmsRole }}',
'{{ region }}'
RETURNING
mission_profile_id
;

Manifest

# Description fields are for documentation purposes
- name: mission_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the mission_profiles resource.
  - name: name
    value: "{{ name }}"
  - name: contactPrePassDurationSeconds
    value: {{ contactPrePassDurationSeconds }}
  - name: contactPostPassDurationSeconds
    value: {{ contactPostPassDurationSeconds }}
  - name: minimumViableContactDurationSeconds
    value: {{ minimumViableContactDurationSeconds }}
  - name: dataflowEdges
    value:
      - "{{ dataflowEdges }}"
  - name: trackingConfigArn
    value: "{{ trackingConfigArn }}"
  - name: telemetrySinkConfigArn
    value: "{{ telemetrySinkConfigArn }}"
  - name: tags
    value: "{{ tags }}"
  - name: streamsKmsKey
    description: |
      KMS key info.
    value:
      kmsKeyArn: "{{ kmsKeyArn }}"
      kmsAliasArn: "{{ kmsAliasArn }}"
      kmsAliasName: "{{ kmsAliasName }}"
  - name: streamsKmsRole
    value: "{{ streamsKmsRole }}"

UPDATE examples

update_mission_profile

Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.

UPDATE aws.groundstation.mission_profiles
SET 
name = '{{ name }}',
contactPrePassDurationSeconds = {{ contactPrePassDurationSeconds }},
contactPostPassDurationSeconds = {{ contactPostPassDurationSeconds }},
minimumViableContactDurationSeconds = {{ minimumViableContactDurationSeconds }},
dataflowEdges = '{{ dataflowEdges }}',
trackingConfigArn = '{{ trackingConfigArn }}',
telemetrySinkConfigArn = '{{ telemetrySinkConfigArn }}',
streamsKmsKey = '{{ streamsKmsKey }}',
streamsKmsRole = '{{ streamsKmsRole }}'
WHERE 
mission_profile_id = '{{ mission_profile_id }}' --required
AND region = '{{ region }}' --required
RETURNING
mission_profile_id;

DELETE examples

delete_mission_profile

Deletes a mission profile.

DELETE FROM aws.groundstation.mission_profiles
WHERE mission_profile_id = '{{ mission_profile_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

reserve_contact

Reserves a contact using specified parameters.

EXEC aws.groundstation.mission_profiles.reserve_contact 
@region='{{ region }}' --required 
@@json=
'{
"missionProfileArn": "{{ missionProfileArn }}", 
"satelliteArn": "{{ satelliteArn }}", 
"startTime": "{{ startTime }}", 
"endTime": "{{ endTime }}", 
"groundStation": "{{ groundStation }}", 
"tags": "{{ tags }}", 
"trackingOverrides": "{{ trackingOverrides }}"
}'
;