AWS Ground Station
API Reference (API Version 2019-05-23)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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 { "endpointDetails": [ { "endpoint": { "address": { "name": "string", "port": number }, "name": "string", "status": "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.

endpointDetails

Endpoint details of each endpoint in the dataflow endpoint group.

Type: Array of EndpointDetails objects

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

ID of a dataflow endpoint group.

Type: String

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: