GetDataflowEndpointGroup - AWS Ground Station

GetDataflowEndpointGroup

Returns the dataflow endpoint group.

Request Syntax

GET /dataflowEndpointGroup/dataflowEndpointGroupId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

dataflowEndpointGroupId

UUID of a dataflow endpoint group.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "dataflowEndpointGroupArn": "string", "dataflowEndpointGroupId": "string", "endpointsDetails": [ { "endpoint": { "address": { "name": "string", "port": number }, "mtu": number, "name": "string", "status": "string" }, "securityDetails": { "roleArn": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ], "tags": { "string" : "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.

dataflowEndpointGroupArn

ARN of a dataflow endpoint group.

Type: String

dataflowEndpointGroupId

UUID of a dataflow endpoint group.

Type: String

endpointsDetails

Details of a dataflow endpoint.

Type: Array of EndpointDetails objects

tags

Tags assigned to a dataflow endpoint group.

Type: String to string map

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: