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

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.

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}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEndpointGroupArn": "string",
   "dataflowEndpointGroupId": "string",
   "endpointsDetails": [ 
      { 
         "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" 
   }
}

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.

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.

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.

dataflowEndpointGroupArn

ARN of a dataflow endpoint group.

Type: String

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}$

endpointsDetails

Details of a dataflow endpoint.

Type: Array of EndpointDetails objects

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

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