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

CreateDataflowEndpointGroup

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

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 /dataflowEndpointGroup HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "endpointDetails": [ 
      { 
         "awsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "egressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "port": number
               }
            },
            "ingressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "portRange": { 
                     "maximum": number,
                     "minimum": number
                  }
               }
            },
            "name": "string"
         },
         "endpoint": { 
            "address": { 
               "name": "string",
               "port": number
            },
            "mtu": number,
            "name": "string",
            "status": "string"
         },
         "healthReasons": [ "string" ],
         "healthStatus": "string",
         "securityDetails": { 
            "roleArn": "string",
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ]
         }
      }
   ],
   "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 120. 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 120. Maximum value of 480.

Required: No

endpointDetails

Endpoint details of each endpoint in the dataflow endpoint group.

Type: Array of EndpointDetails objects

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

Required: Yes

tags

Tags of a 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

UUID of a dataflow endpoint group.

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