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

CreateDataflowEndpointGroupV2

Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

Request Syntax


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

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "endpoints": [ 
      { ... }
   ],
   "tags": { 
      "string" : "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, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

Type: Integer

Valid Range: Minimum value of 30. Maximum value of 480.

Required: No

contactPrePassDurationSeconds

Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

Type: Integer

Valid Range: Minimum value of 30. Maximum value of 480.

Required: No

endpoints

Dataflow endpoint group's endpoint definitions

Type: Array of CreateEndpointDetails objects

Array Members: Minimum number of 1 item. Maximum number of 12 items.

Required: Yes

tags

Tags of a V2 dataflow endpoint group.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dataflowEndpointGroupId": "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.

dataflowEndpointGroupId

Dataflow endpoint group ID

Type: String

Length Constraints: Fixed length of 36.

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.

parameterName

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

parameterName

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

parameterName: Parameter name that caused the exception

HTTP Status Code: 402