Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMissionProfile

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.

Request Syntax


POST /missionprofile HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEdges": [ 
      [ "string" ]
   ],
   "minimumViableContactDurationSeconds": number,
   "name": "string",
   "streamsKmsKey": { ... },
   "streamsKmsRole": "string",
   "tags": { 
      "string" : "string" 
   },
   "trackingConfigArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

contactPostPassDurationSeconds

Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 21600.

Required: No

contactPrePassDurationSeconds

Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 21600.

Required: No

dataflowEdges

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

Type: Array of arrays of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Array Members: Fixed number of 2 items.

Required: Yes

minimumViableContactDurationSeconds

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 21600.

Required: Yes

name

Name of a mission profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[ a-zA-Z0-9_:-]{1,256}$

Required: Yes

streamsKmsKey

KMS key to use for encrypting streams.

Type: KmsKey object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

streamsKmsRole

Role to use for encrypting streams with KMS key.

Type: String

Required: No

tags

Tags assigned to a mission profile.

Type: String to string map

Required: No

trackingConfigArn

ARN of a tracking Config.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "missionProfileId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

missionProfileId

UUID of a mission profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434