2023/04/12 - AWS Ground Station - 4 updated api methods
Changes AWS Ground Station Wideband DigIF GA Release
{'endpointDetails': {'healthReasons': ['NO_REGISTERED_AGENT | '
'INVALID_IP_OWNERSHIP | '
'NOT_AUTHORIZED_TO_CREATE_SLR | '
'UNVERIFIED_IP_OWNERSHIP | '
'INITIALIZING_DATAPLANE | '
'DATAPLANE_FAILURE | HEALTHY'],
'healthStatus': 'UNHEALTHY | HEALTHY'}}
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(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
endpointDetails=[
{
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
],
'healthStatus': 'UNHEALTHY'|'HEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
],
tags={
'string': 'string'
}
)
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.
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.
list
[REQUIRED]
Endpoint details of each endpoint in the dataflow endpoint group.
(dict) --
Information about the endpoint details.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
egressAddress (dict) -- [REQUIRED]
The egress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) -- [REQUIRED]
A socket address.
name (string) -- [REQUIRED]
Name of a socket address.
port (integer) -- [REQUIRED]
Port of a socket address.
ingressAddress (dict) -- [REQUIRED]
The ingress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) -- [REQUIRED]
A ranged socket address.
name (string) -- [REQUIRED]
IPv4 socket address.
portRange (dict) -- [REQUIRED]
Port range of a socket address.
maximum (integer) -- [REQUIRED]
A maximum value.
minimum (integer) -- [REQUIRED]
A minimum value.
name (string) -- [REQUIRED]
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
endpoint (dict) --
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.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup .
(string) --
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup .
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
roleArn (string) -- [REQUIRED]
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) -- [REQUIRED]
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) -- [REQUIRED]
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
dict
Tags of a dataflow endpoint group.
(string) --
(string) --
dict
Response Syntax
{
'dataflowEndpointGroupId': 'string'
}
Response Structure
(dict) --
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
{'dataflowList': {'destination': {'configDetails': {'endpointDetails': {'healthReasons': ['NO_REGISTERED_AGENT '
'| '
'INVALID_IP_OWNERSHIP '
'| '
'NOT_AUTHORIZED_TO_CREATE_SLR '
'| '
'UNVERIFIED_IP_OWNERSHIP '
'| '
'INITIALIZING_DATAPLANE '
'| '
'DATAPLANE_FAILURE '
'| '
'HEALTHY'],
'healthStatus': 'UNHEALTHY '
'| '
'HEALTHY'}}},
'source': {'configDetails': {'endpointDetails': {'healthReasons': ['NO_REGISTERED_AGENT '
'| '
'INVALID_IP_OWNERSHIP '
'| '
'NOT_AUTHORIZED_TO_CREATE_SLR '
'| '
'UNVERIFIED_IP_OWNERSHIP '
'| '
'INITIALIZING_DATAPLANE '
'| '
'DATAPLANE_FAILURE '
'| '
'HEALTHY'],
'healthStatus': 'UNHEALTHY '
'| '
'HEALTHY'}}}}}
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',
'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
'dataflowList': [
{
'destination': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
],
'healthStatus': 'UNHEALTHY'|'HEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string',
'source': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
],
'healthStatus': 'UNHEALTHY'|'HEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'dataflowSourceRegion': 'string'
}
},
],
'endTime': datetime(2015, 1, 1),
'errorMessage': 'string',
'groundStation': 'string',
'maximumElevation': {
'unit': 'DEGREE_ANGLE'|'RADIAN',
'value': 123.0
},
'missionProfileArn': 'string',
'postPassEndTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'region': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
contactStatus (string) --
Status 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.
destination (dict) --
Dataflow details for the destination side.
configDetails (dict) --
Additional details for a Config , if type is dataflow endpoint or antenna demod decode.
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.
endpointDetails (dict) --
Information about the endpoint details.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
egressAddress (dict) --
The egress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
maximum (integer) --
A maximum value.
minimum (integer) --
A minimum value.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
endpoint (dict) --
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.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup .
(string) --
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup .
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
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
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
source (dict) --
Dataflow details for the source side.
configDetails (dict) --
Additional details for a Config , if type is dataflow-endpoint or antenna-downlink-demod-decode
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.
endpointDetails (dict) --
Information about the endpoint details.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
egressAddress (dict) --
The egress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
maximum (integer) --
A maximum value.
minimum (integer) --
A minimum value.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
endpoint (dict) --
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.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup .
(string) --
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup .
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
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
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
dataflowSourceRegion (string) --
Region of a dataflow source.
endTime (datetime) --
End time of a contact in UTC.
errorMessage (string) --
Error message for a contact.
groundStation (string) --
Ground station for a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
unit (string) --
Elevation angle units.
value (float) --
Elevation angle value.
missionProfileArn (string) --
ARN of a mission profile.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
prePassStartTime (datetime) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
region (string) --
Region of a contact.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
{'endpointsDetails': {'healthReasons': ['NO_REGISTERED_AGENT | '
'INVALID_IP_OWNERSHIP | '
'NOT_AUTHORIZED_TO_CREATE_SLR | '
'UNVERIFIED_IP_OWNERSHIP | '
'INITIALIZING_DATAPLANE | '
'DATAPLANE_FAILURE | HEALTHY'],
'healthStatus': 'UNHEALTHY | HEALTHY'}}
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
{
'contactPostPassDurationSeconds': 123,
'contactPrePassDurationSeconds': 123,
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string',
'endpointsDetails': [
{
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
],
'healthStatus': 'UNHEALTHY'|'HEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
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.
dataflowEndpointGroupArn (string) --
ARN of a dataflow endpoint group.
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
endpointsDetails (list) --
Details of a dataflow endpoint.
(dict) --
Information about the endpoint details.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
egressAddress (dict) --
The egress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
maximum (integer) --
A maximum value.
minimum (integer) --
A minimum value.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
endpoint (dict) --
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.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup .
(string) --
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup .
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
tags (dict) --
Tags assigned to a dataflow endpoint group.
(string) --
(string) --
{'agentDetails': {'agentCpuCores': ['integer']}}
Note
For use by AWS Ground Station Agent and shouldn't be called directly.
Registers a new agent with AWS Ground Station.
See also: AWS API Documentation
Request Syntax
client.register_agent(
agentDetails={
'agentCpuCores': [
123,
],
'agentVersion': 'string',
'componentVersions': [
{
'componentType': 'string',
'versions': [
'string',
]
},
],
'instanceId': 'string',
'instanceType': 'string',
'reservedCpuCores': [
123,
]
},
discoveryData={
'capabilityArns': [
'string',
],
'privateIpAddresses': [
'string',
],
'publicIpAddresses': [
'string',
]
}
)
dict
[REQUIRED]
Detailed information about the agent being registered.
agentCpuCores (list) --
List of CPU cores reserved for the agent.
(integer) --
agentVersion (string) -- [REQUIRED]
Current agent version.
componentVersions (list) -- [REQUIRED]
List of versions being used by agent components.
(dict) --
Version information for agent components.
componentType (string) -- [REQUIRED]
Component type.
versions (list) -- [REQUIRED]
List of versions.
(string) --
instanceId (string) -- [REQUIRED]
ID of EC2 instance agent is running on.
instanceType (string) -- [REQUIRED]
Type of EC2 instance agent is running on.
reservedCpuCores (list) --
Note
This field should not be used. Use agentCpuCores instead.
List of CPU cores reserved for processes other than the agent running on the EC2 instance.
(integer) --
dict
[REQUIRED]
Data for associating an agent with the capabilities it is managing.
capabilityArns (list) -- [REQUIRED]
List of capabilities to associate with agent.
(string) --
privateIpAddresses (list) -- [REQUIRED]
List of private IP addresses to associate with agent.
(string) --
publicIpAddresses (list) -- [REQUIRED]
List of public IP addresses to associate with agent.
(string) --
dict
Response Syntax
{
'agentId': 'string'
}
Response Structure
(dict) --
agentId (string) --
UUID of registered agent.