2025/11/05 - AWS Ground Station - 2 new3 updated api methods
Changes Introduce CreateDataflowEndpointGroupV2 action
Gets a presigned URL for uploading agent task response logs.
See also: AWS API Documentation
Request Syntax
client.get_agent_task_response_url(
agentId='string',
taskId='string'
)
string
[REQUIRED]
UUID of agent requesting the response URL.
string
[REQUIRED]
GUID of the agent task for which the response URL is being requested.
dict
Response Syntax
{
'agentId': 'string',
'taskId': 'string',
'presignedLogUrl': 'string'
}
Response Structure
(dict) --
agentId (string) --
UUID of the agent.
taskId (string) --
GUID of the agent task.
presignedLogUrl (string) --
Presigned URL for uploading agent task response logs.
Creates a DataflowEndpointGroupV2 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.
See also: AWS API Documentation
Request Syntax
client.create_dataflow_endpoint_group_v2(
endpoints=[
{
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
}
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
}
}
},
],
contactPrePassDurationSeconds=123,
contactPostPassDurationSeconds=123,
tags={
'string': 'string'
}
)
list
[REQUIRED]
Dataflow endpoint group's endpoint definitions
(dict) --
Endpoint definition used for creating a dataflow endpoint
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) -- [REQUIRED]
Uplink dataflow endpoint name
dataflowDetails (dict) -- [REQUIRED]
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) -- [REQUIRED]
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) -- [REQUIRED]
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
minimum (integer) -- [REQUIRED]
A minimum value.
maximum (integer) -- [REQUIRED]
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) -- [REQUIRED]
Downlink dataflow endpoint name
dataflowDetails (dict) -- [REQUIRED]
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) -- [REQUIRED]
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
minimum (integer) -- [REQUIRED]
A minimum value.
maximum (integer) -- [REQUIRED]
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) -- [REQUIRED]
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
integer
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.
integer
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.
dict
Tags of a V2 dataflow endpoint group.
(string) --
(string) --
dict
Response Syntax
{
'dataflowEndpointGroupId': 'string'
}
Response Structure
(dict) --
dataflowEndpointGroupId (string) --
Dataflow endpoint group ID
{'endpointDetails': {'downlinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'egressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'},
'uplinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'ingressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_dataflow_endpoint_group(
endpointDetails=[
{
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
],
tags={
'string': 'string'
},
contactPrePassDurationSeconds=123,
contactPostPassDurationSeconds=123
)
list
[REQUIRED]
Endpoint details of each endpoint in the dataflow endpoint group. All dataflow endpoints within a single dataflow endpoint group must be of the same type. You cannot mix AWS Ground Station Agent endpoints with Dataflow endpoints in the same group. If your use case requires both types of endpoints, you must create separate dataflow endpoint groups for each type.
(dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) -- [REQUIRED]
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) -- [REQUIRED]
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) -- [REQUIRED]
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) -- [REQUIRED]
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) -- [REQUIRED]
The egress address of AgentEndpoint.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) -- [REQUIRED]
The ingress address of AgentEndpoint.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
minimum (integer) -- [REQUIRED]
A minimum value.
maximum (integer) -- [REQUIRED]
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) -- [REQUIRED]
Uplink dataflow endpoint name
dataflowDetails (dict) -- [REQUIRED]
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) -- [REQUIRED]
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) -- [REQUIRED]
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
minimum (integer) -- [REQUIRED]
A minimum value.
maximum (integer) -- [REQUIRED]
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) -- [REQUIRED]
Downlink dataflow endpoint name
dataflowDetails (dict) -- [REQUIRED]
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) -- [REQUIRED]
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
minimum (integer) -- [REQUIRED]
A minimum value.
maximum (integer) -- [REQUIRED]
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) -- [REQUIRED]
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
dict
Tags of a dataflow endpoint group.
(string) --
(string) --
integer
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.
integer
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.
dict
Response Syntax
{
'dataflowEndpointGroupId': 'string'
}
Response Structure
(dict) --
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
{'dataflowList': {'destination': {'configDetails': {'endpointDetails': {'downlinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'egressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'},
'uplinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'ingressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'}}}},
'source': {'configDetails': {'endpointDetails': {'downlinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'egressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'},
'uplinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'ingressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'}}}}}}
Describes an existing contact.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
contactId='string'
)
string
[REQUIRED]
UUID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'missionProfileArn': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'postPassEndTime': datetime(2015, 1, 1),
'groundStation': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'errorMessage': 'string',
'maximumElevation': {
'value': 123.0,
'unit': 'DEGREE_ANGLE'|'RADIAN'
},
'tags': {
'string': 'string'
},
'region': 'string',
'dataflowList': [
{
'source': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowSourceRegion': 'string'
},
'destination': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string'
},
],
'visibilityStartTime': datetime(2015, 1, 1),
'visibilityEndTime': datetime(2015, 1, 1),
'trackingOverrides': {
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
}
}
},
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
}
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
missionProfileArn (string) --
ARN of a mission profile.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
endTime (datetime) --
End time of a contact in UTC.
prePassStartTime (datetime) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
groundStation (string) --
Ground station for a contact.
contactStatus (string) --
Status of a contact.
errorMessage (string) --
Error message for a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
value (float) --
Elevation angle value.
unit (string) --
Elevation angle units.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
region (string) --
Region of a contact.
dataflowList (list) --
List describing source and destination details for each dataflow edge.
(dict) --
Information about a dataflow edge used in a contact.
source (dict) --
Dataflow details for the source side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowSourceRegion (string) --
Region of a dataflow source.
destination (dict) --
Dataflow details for the destination side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
visibilityStartTime (datetime) --
Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
visibilityEndTime (datetime) --
Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
trackingOverrides (dict) --
Tracking configuration overrides specified when the contact was reserved.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) --
Unique identifier of the azimuth elevation ephemeris.
ephemeris (dict) --
The ephemeris that determines antenna pointing directions for the contact.
ephemerisId (string) --
Unique identifier of the ephemeris. Appears only for custom ephemerides.
ephemerisType (string) --
Type of ephemeris.
{'endpointsDetails': {'downlinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'egressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'},
'uplinkAwsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
'| '
'FAILED '
'| '
'ACTIVE '
'| '
'INACTIVE',
'auditResults': 'HEALTHY '
'| '
'UNHEALTHY',
'dataflowDetails': {'agentConnectionDetails': {'agentIpAndPortAddress': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'portRange': {'maximum': 'integer',
'minimum': 'integer'}}},
'ingressAddressAndPort': {'mtu': 'integer',
'socketAddress': {'name': 'string',
'port': 'integer'}}}},
'name': 'string'}}}
Returns the dataflow endpoint group.
See also: AWS API Documentation
Request Syntax
client.get_dataflow_endpoint_group(
dataflowEndpointGroupId='string'
)
string
[REQUIRED]
UUID of a dataflow endpoint group.
dict
Response Syntax
{
'dataflowEndpointGroupId': 'string',
'dataflowEndpointGroupArn': 'string',
'endpointsDetails': [
{
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
],
'tags': {
'string': 'string'
},
'contactPrePassDurationSeconds': 123,
'contactPostPassDurationSeconds': 123
}
Response Structure
(dict) --
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
dataflowEndpointGroupArn (string) --
ARN of a dataflow endpoint group.
endpointsDetails (list) --
Details of a dataflow endpoint.
(dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
tags (dict) --
Tags assigned to a dataflow endpoint group.
(string) --
(string) --
contactPrePassDurationSeconds (integer) --
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.
contactPostPassDurationSeconds (integer) --
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.