GroundStation
*************
Client
======
class GroundStation.Client
A low-level client representing AWS Ground Station
Welcome to the AWS Ground Station API Reference. AWS Ground Station
is a fully managed service that enables you to control satellite
communications, downlink and process satellite data, and scale your
satellite operations efficiently and cost-effectively without
having to build or manage your own ground station infrastructure.
import boto3
client = boto3.client('groundstation')
These are the available methods:
* can_paginate
* cancel_contact
* close
* create_config
* create_dataflow_endpoint_group
* create_ephemeris
* create_mission_profile
* delete_config
* delete_dataflow_endpoint_group
* delete_ephemeris
* delete_mission_profile
* describe_contact
* describe_ephemeris
* get_agent_configuration
* get_config
* get_dataflow_endpoint_group
* get_minute_usage
* get_mission_profile
* get_paginator
* get_satellite
* get_waiter
* list_configs
* list_contacts
* list_dataflow_endpoint_groups
* list_ephemerides
* list_ground_stations
* list_mission_profiles
* list_satellites
* list_tags_for_resource
* register_agent
* reserve_contact
* tag_resource
* untag_resource
* update_agent_status
* update_config
* update_ephemeris
* update_mission_profile
Paginators
==========
Paginators are available on a client instance via the "get_paginator"
method. For more detailed instructions and examples on the usage of
paginators, see the paginators user guide.
The available paginators are:
* ListConfigs
* ListContacts
* ListDataflowEndpointGroups
* ListEphemerides
* ListGroundStations
* ListMissionProfiles
* ListSatellites
Waiters
=======
Waiters are available on a client instance via the "get_waiter"
method. For more detailed instructions and examples on the usage or
waiters, see the waiters user guide.
The available waiters are:
* ContactScheduled
GroundStation / Waiter / ContactScheduled
ContactScheduled
****************
class GroundStation.Waiter.ContactScheduled
waiter = client.get_waiter('contact_scheduled')
wait(**kwargs)
Polls "GroundStation.Client.describe_contact()" every 5 seconds
until a successful state is reached. An error is raised after
180 failed checks.
See also: AWS API Documentation
**Request Syntax**
waiter.wait(
contactId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Parameters:
* **contactId** (*string*) --
**[REQUIRED]**
UUID of a contact.
* **WaiterConfig** (*dict*) --
A dictionary that provides parameters to control waiting
behavior.
* **Delay** *(integer) --*
The amount of time in seconds to wait between attempts.
Default: 5
* **MaxAttempts** *(integer) --*
The maximum number of attempts to be made. Default: 180
Returns:
None
GroundStation / Paginator / ListMissionProfiles
ListMissionProfiles
*******************
class GroundStation.Paginator.ListMissionProfiles
paginator = client.get_paginator('list_mission_profiles')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_mission_profiles()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
**PaginationConfig** (*dict*) --
A dictionary that provides parameters to control pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number of
items available is more than the value specified in max-
items then a "NextToken" will be provided in the output
that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'missionProfileList': [
{
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **missionProfileList** *(list) --*
List of mission profiles.
* *(dict) --*
Item in a list of mission profiles.
* **missionProfileArn** *(string) --*
ARN of a mission profile.
* **missionProfileId** *(string) --*
UUID of a mission profile.
* **name** *(string) --*
Name of a mission profile.
* **region** *(string) --*
Region of a mission profile.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListSatellites
ListSatellites
**************
class GroundStation.Paginator.ListSatellites
paginator = client.get_paginator('list_satellites')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_satellites()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
**PaginationConfig** (*dict*) --
A dictionary that provides parameters to control pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number of
items available is more than the value specified in max-
items then a "NextToken" will be provided in the output
that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'satellites': [
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **satellites** *(list) --*
List of satellites.
* *(dict) --*
Item in a list of satellites.
* **currentEphemeris** *(dict) --*
The current ephemeris being used to compute the
trajectory of the satellite.
* **ephemerisId** *(string) --*
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides
from Space Track.
* **epoch** *(datetime) --*
The epoch of a default, ephemeris from Space Track
in UTC.
This field is not populated for customer-provided
ephemerides.
* **name** *(string) --*
A name string associated with the ephemeris. Used
as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider
ephemerides that have a name associated.
* **source** *(string) --*
The "EphemerisSource" that generated a given
ephemeris.
* **groundStations** *(list) --*
A list of ground stations to which the satellite is
on-boarded.
* *(string) --*
* **noradSatelliteID** *(integer) --*
NORAD satellite ID number.
* **satelliteArn** *(string) --*
ARN of a satellite.
* **satelliteId** *(string) --*
UUID of a satellite.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListConfigs
ListConfigs
***********
class GroundStation.Paginator.ListConfigs
paginator = client.get_paginator('list_configs')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_configs()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
**PaginationConfig** (*dict*) --
A dictionary that provides parameters to control pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number of
items available is more than the value specified in max-
items then a "NextToken" will be provided in the output
that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'configList': [
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
'name': 'string'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **configList** *(list) --*
List of "Config" items.
* *(dict) --*
An item in a list of "Config" objects.
* **configArn** *(string) --*
ARN of a "Config".
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
* **name** *(string) --*
Name of a "Config".
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListEphemerides
ListEphemerides
***************
class GroundStation.Paginator.ListEphemerides
paginator = client.get_paginator('list_ephemerides')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_ephemerides()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
satelliteId='string',
startTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
* **endTime** (*datetime*) --
**[REQUIRED]**
The end time to list in UTC. The operation will return an
ephemeris if its expiration time is within the time range
defined by the "startTime" and "endTime".
* **satelliteId** (*string*) --
**[REQUIRED]**
The AWS Ground Station satellite ID to list ephemeris for.
* **startTime** (*datetime*) --
**[REQUIRED]**
The start time to list in UTC. The operation will return an
ephemeris if its expiration time is within the time range
defined by the "startTime" and "endTime".
* **statusList** (*list*) --
The list of ephemeris status to return.
* *(string) --*
* **PaginationConfig** (*dict*) --
A dictionary that provides parameters to control
pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number
of items available is more than the value specified in
max-items then a "NextToken" will be provided in the
output that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'ephemerides': [
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'name': 'string',
'priority': 123,
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **ephemerides** *(list) --*
List of ephemerides.
* *(dict) --*
Ephemeris item.
* **creationTime** *(datetime) --*
The time the ephemeris was uploaded in UTC.
* **enabled** *(boolean) --*
Whether or not the ephemeris is enabled.
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
* **name** *(string) --*
A name string associated with the ephemeris. Used as
a human-readable identifier for the ephemeris.
* **priority** *(integer) --*
Customer-provided priority score to establish the
order in which overlapping ephemerides should be
used.
The default for customer-provided ephemeris priority
is 1, and higher numbers take precedence.
Priority must be 1 or greater
* **sourceS3Object** *(dict) --*
Source S3 object used for the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for
the ephemeris.
* **status** *(string) --*
The status of the ephemeris.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListGroundStations
ListGroundStations
******************
class GroundStation.Paginator.ListGroundStations
paginator = client.get_paginator('list_ground_stations')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_ground_stations()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
satelliteId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
* **satelliteId** (*string*) -- Satellite ID to retrieve on-
boarded ground stations.
* **PaginationConfig** (*dict*) --
A dictionary that provides parameters to control
pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number
of items available is more than the value specified in
max-items then a "NextToken" will be provided in the
output that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'groundStationList': [
{
'groundStationId': 'string',
'groundStationName': 'string',
'region': 'string'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **groundStationList** *(list) --*
List of ground stations.
* *(dict) --*
Information about the ground station data.
* **groundStationId** *(string) --*
UUID of a ground station.
* **groundStationName** *(string) --*
Name of a ground station.
* **region** *(string) --*
Ground station Region.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListContacts
ListContacts
************
class GroundStation.Paginator.ListContacts
paginator = client.get_paginator('list_contacts')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_contacts()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
groundStation='string',
missionProfileArn='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
statusList=[
'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
* **endTime** (*datetime*) --
**[REQUIRED]**
End time of a contact in UTC.
* **groundStation** (*string*) -- Name of a ground station.
* **missionProfileArn** (*string*) -- ARN of a mission
profile.
* **satelliteArn** (*string*) -- ARN of a satellite.
* **startTime** (*datetime*) --
**[REQUIRED]**
Start time of a contact in UTC.
* **statusList** (*list*) --
**[REQUIRED]**
Status of a contact reservation.
* *(string) --*
* **PaginationConfig** (*dict*) --
A dictionary that provides parameters to control
pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number
of items available is more than the value specified in
max-items then a "NextToken" will be provided in the
output that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'contactList': [
{
'contactId': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'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'
},
'visibilityEndTime': datetime(2015, 1, 1),
'visibilityStartTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **contactList** *(list) --*
List of contacts.
* *(dict) --*
Data describing a contact.
* **contactId** *(string) --*
UUID of a contact.
* **contactStatus** *(string) --*
Status of a contact.
* **endTime** *(datetime) --*
End time of a contact in UTC.
* **errorMessage** *(string) --*
Error message of a contact.
* **groundStation** *(string) --*
Name of a ground station.
* **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) --*
* **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. This field
is not present for contacts with a "SCHEDULING" or
"SCHEDULED" status.
* **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. This field
is not present for contacts with a "SCHEDULING" or
"SCHEDULED" status.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Paginator / ListDataflowEndpointGroups
ListDataflowEndpointGroups
**************************
class GroundStation.Paginator.ListDataflowEndpointGroups
paginator = client.get_paginator('list_dataflow_endpoint_groups')
paginate(**kwargs)
Creates an iterator that will paginate through responses from
"GroundStation.Client.list_dataflow_endpoint_groups()".
See also: AWS API Documentation
**Request Syntax**
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters:
**PaginationConfig** (*dict*) --
A dictionary that provides parameters to control pagination.
* **MaxItems** *(integer) --*
The total number of items to return. If the total number of
items available is more than the value specified in max-
items then a "NextToken" will be provided in the output
that you can use to resume pagination.
* **PageSize** *(integer) --*
The size of each page.
* **StartingToken** *(string) --*
A token to specify where to start paginating. This is the
"NextToken" from a previous response.
Return type:
dict
Returns:
**Response Syntax**
{
'dataflowEndpointGroupList': [
{
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string'
},
],
'NextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **dataflowEndpointGroupList** *(list) --*
A list of dataflow endpoint groups.
* *(dict) --*
Item in a list of "DataflowEndpoint" groups.
* **dataflowEndpointGroupArn** *(string) --*
ARN of a dataflow endpoint group.
* **dataflowEndpointGroupId** *(string) --*
UUID of a dataflow endpoint group.
* **NextToken** *(string) --*
A token to resume pagination.
GroundStation / Client / get_paginator
get_paginator
*************
GroundStation.Client.get_paginator(operation_name)
Create a paginator for an operation.
Parameters:
**operation_name** (*string*) -- The operation name. This is
the same name as the method name on the client. For example, if
the method name is "create_foo", and you'd normally invoke the
operation as "client.create_foo(**kwargs)", if the "create_foo"
operation can be paginated, you can use the call
"client.get_paginator("create_foo")".
Raises:
**OperationNotPageableError** -- Raised if the operation is not
pageable. You can use the "client.can_paginate" method to check
if an operation is pageable.
Return type:
"botocore.paginate.Paginator"
Returns:
A paginator object.
GroundStation / Client / get_minute_usage
get_minute_usage
****************
GroundStation.Client.get_minute_usage(**kwargs)
Returns the number of reserved minutes used by account.
See also: AWS API Documentation
**Request Syntax**
response = client.get_minute_usage(
month=123,
year=123
)
Parameters:
* **month** (*integer*) --
**[REQUIRED]**
The month being requested, with a value of 1-12.
* **year** (*integer*) --
**[REQUIRED]**
The year being requested, in the format of YYYY.
Return type:
dict
Returns:
**Response Syntax**
{
'estimatedMinutesRemaining': 123,
'isReservedMinutesCustomer': True|False,
'totalReservedMinuteAllocation': 123,
'totalScheduledMinutes': 123,
'upcomingMinutesScheduled': 123
}
**Response Structure**
* *(dict) --*
* **estimatedMinutesRemaining** *(integer) --*
Estimated number of minutes remaining for an account,
specific to the month being requested.
* **isReservedMinutesCustomer** *(boolean) --*
Returns whether or not an account has signed up for the
reserved minutes pricing plan, specific to the month being
requested.
* **totalReservedMinuteAllocation** *(integer) --*
Total number of reserved minutes allocated, specific to the
month being requested.
* **totalScheduledMinutes** *(integer) --*
Total scheduled minutes for an account, specific to the
month being requested.
* **upcomingMinutesScheduled** *(integer) --*
Upcoming minutes scheduled for an account, specific to the
month being requested.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_satellites
list_satellites
***************
GroundStation.Client.list_satellites(**kwargs)
Returns a list of satellites.
See also: AWS API Documentation
**Request Syntax**
response = client.list_satellites(
maxResults=123,
nextToken='string'
)
Parameters:
* **maxResults** (*integer*) -- Maximum number of satellites
returned.
* **nextToken** (*string*) -- Next token that can be supplied in
the next call to get the next page of satellites.
Return type:
dict
Returns:
**Response Syntax**
{
'nextToken': 'string',
'satellites': [
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
},
]
}
**Response Structure**
* *(dict) --*
* **nextToken** *(string) --*
Next token that can be supplied in the next call to get the
next page of satellites.
* **satellites** *(list) --*
List of satellites.
* *(dict) --*
Item in a list of satellites.
* **currentEphemeris** *(dict) --*
The current ephemeris being used to compute the
trajectory of the satellite.
* **ephemerisId** *(string) --*
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides
from Space Track.
* **epoch** *(datetime) --*
The epoch of a default, ephemeris from Space Track in
UTC.
This field is not populated for customer-provided
ephemerides.
* **name** *(string) --*
A name string associated with the ephemeris. Used as a
human-readable identifier for the ephemeris.
A name is only returned for customer-provider
ephemerides that have a name associated.
* **source** *(string) --*
The "EphemerisSource" that generated a given
ephemeris.
* **groundStations** *(list) --*
A list of ground stations to which the satellite is on-
boarded.
* *(string) --*
* **noradSatelliteID** *(integer) --*
NORAD satellite ID number.
* **satelliteArn** *(string) --*
ARN of a satellite.
* **satelliteId** *(string) --*
UUID of a satellite.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / cancel_contact
cancel_contact
**************
GroundStation.Client.cancel_contact(**kwargs)
Cancels a contact with a specified contact ID.
See also: AWS API Documentation
**Request Syntax**
response = client.cancel_contact(
contactId='string'
)
Parameters:
**contactId** (*string*) --
**[REQUIRED]**
UUID of a contact.
Return type:
dict
Returns:
**Response Syntax**
{
'contactId': 'string'
}
**Response Structure**
* *(dict) --*
* **contactId** *(string) --*
UUID of a contact.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / update_config
update_config
*************
GroundStation.Client.update_config(**kwargs)
Updates the "Config" used when scheduling contacts.
Updating a "Config" will not update the execution parameters for
existing future contacts scheduled with this "Config".
See also: AWS API Documentation
**Request Syntax**
response = client.update_config(
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
name='string'
)
Parameters:
* **configData** (*dict*) --
**[REQUIRED]**
Parameters of a "Config".
Note:
This is a Tagged Union structure. Only one of the
following top level keys can be set:
"antennaDownlinkConfig", "antennaDownlinkDemodDecodeConfig",
"antennaUplinkConfig", "dataflowEndpointConfig",
"s3RecordingConfig", "trackingConfig", "uplinkEchoConfig".
* **antennaDownlinkConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for downlink during a contact.
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Object that describes a spectral "Config".
* **bandwidth** *(dict) --* **[REQUIRED]**
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between 10
kHz to 54 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency bandwidth units.
* **value** *(float) --* **[REQUIRED]**
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaDownlinkDemodDecodeConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for downlink demod decode during a contact.
* **decodeConfig** *(dict) --* **[REQUIRED]**
Information about the decode "Config".
* **unvalidatedJSON** *(string) --* **[REQUIRED]**
Unvalidated JSON of a decode "Config".
* **demodulationConfig** *(dict) --* **[REQUIRED]**
Information about the demodulation "Config".
* **unvalidatedJSON** *(string) --* **[REQUIRED]**
Unvalidated JSON of a demodulation "Config".
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Information about the spectral "Config".
* **bandwidth** *(dict) --* **[REQUIRED]**
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between 10
kHz to 54 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency bandwidth units.
* **value** *(float) --* **[REQUIRED]**
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaUplinkConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for uplink during a contact.
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Information about the uplink spectral "Config".
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of an uplink spectral "Config". Valid
values are between 2025 to 2120 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of an uplink spectral "Config". Capturing
both ""RIGHT_HAND"" and ""LEFT_HAND"" polarization
requires two separate configs.
* **targetEirp** *(dict) --* **[REQUIRED]**
EIRP of the target.
* **units** *(string) --* **[REQUIRED]**
Units of an EIRP.
* **value** *(float) --* **[REQUIRED]**
Value of an EIRP. Valid values are between 20.0 to 50.0
dBW.
* **transmitDisabled** *(boolean) --*
Whether or not uplink transmit is disabled.
* **dataflowEndpointConfig** *(dict) --*
Information about the dataflow endpoint "Config".
* **dataflowEndpointName** *(string) --* **[REQUIRED]**
Name of a dataflow endpoint.
* **dataflowEndpointRegion** *(string) --*
Region of a dataflow endpoint.
* **s3RecordingConfig** *(dict) --*
Information about an S3 recording "Config".
* **bucketArn** *(string) --* **[REQUIRED]**
ARN of the bucket to record to.
* **prefix** *(string) --*
S3 Key prefix to prefice data files.
* **roleArn** *(string) --* **[REQUIRED]**
ARN of the role Ground Station assumes to write data to
the bucket.
* **trackingConfig** *(dict) --*
Object that determines whether tracking should be used
during a contact executed with this "Config" in the mission
profile.
* **autotrack** *(string) --* **[REQUIRED]**
Current setting for autotrack.
* **uplinkEchoConfig** *(dict) --*
Information about an uplink echo "Config".
Parameters from the "AntennaUplinkConfig", corresponding to
the specified "AntennaUplinkConfigArn", are used when this
"UplinkEchoConfig" is used in a contact.
* **antennaUplinkConfigArn** *(string) --* **[REQUIRED]**
ARN of an uplink "Config".
* **enabled** *(boolean) --* **[REQUIRED]**
Whether or not an uplink "Config" is enabled.
* **configId** (*string*) --
**[REQUIRED]**
UUID of a "Config".
* **configType** (*string*) --
**[REQUIRED]**
Type of a "Config".
* **name** (*string*) --
**[REQUIRED]**
Name of a "Config".
Return type:
dict
Returns:
**Response Syntax**
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'
}
**Response Structure**
* *(dict) --*
* **configArn** *(string) --*
ARN of a "Config".
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / delete_config
delete_config
*************
GroundStation.Client.delete_config(**kwargs)
Deletes a "Config".
See also: AWS API Documentation
**Request Syntax**
response = client.delete_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'
)
Parameters:
* **configId** (*string*) --
**[REQUIRED]**
UUID of a "Config".
* **configType** (*string*) --
**[REQUIRED]**
Type of a "Config".
Return type:
dict
Returns:
**Response Syntax**
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'
}
**Response Structure**
* *(dict) --*
* **configArn** *(string) --*
ARN of a "Config".
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / can_paginate
can_paginate
************
GroundStation.Client.can_paginate(operation_name)
Check if an operation can be paginated.
Parameters:
**operation_name** (*string*) -- The operation name. This is
the same name as the method name on the client. For example, if
the method name is "create_foo", and you'd normally invoke the
operation as "client.create_foo(**kwargs)", if the "create_foo"
operation can be paginated, you can use the call
"client.get_paginator("create_foo")".
Returns:
"True" if the operation can be paginated, "False" otherwise.
GroundStation / Client / create_config
create_config
*************
GroundStation.Client.create_config(**kwargs)
Creates a "Config" with the specified "configData" parameters.
Only one type of "configData" can be specified.
See also: AWS API Documentation
**Request Syntax**
response = client.create_config(
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
name='string',
tags={
'string': 'string'
}
)
Parameters:
* **configData** (*dict*) --
**[REQUIRED]**
Parameters of a "Config".
Note:
This is a Tagged Union structure. Only one of the
following top level keys can be set:
"antennaDownlinkConfig", "antennaDownlinkDemodDecodeConfig",
"antennaUplinkConfig", "dataflowEndpointConfig",
"s3RecordingConfig", "trackingConfig", "uplinkEchoConfig".
* **antennaDownlinkConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for downlink during a contact.
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Object that describes a spectral "Config".
* **bandwidth** *(dict) --* **[REQUIRED]**
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between 10
kHz to 54 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency bandwidth units.
* **value** *(float) --* **[REQUIRED]**
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaDownlinkDemodDecodeConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for downlink demod decode during a contact.
* **decodeConfig** *(dict) --* **[REQUIRED]**
Information about the decode "Config".
* **unvalidatedJSON** *(string) --* **[REQUIRED]**
Unvalidated JSON of a decode "Config".
* **demodulationConfig** *(dict) --* **[REQUIRED]**
Information about the demodulation "Config".
* **unvalidatedJSON** *(string) --* **[REQUIRED]**
Unvalidated JSON of a demodulation "Config".
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Information about the spectral "Config".
* **bandwidth** *(dict) --* **[REQUIRED]**
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between 10
kHz to 54 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency bandwidth units.
* **value** *(float) --* **[REQUIRED]**
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaUplinkConfig** *(dict) --*
Information about how AWS Ground Station should configure an
antenna for uplink during a contact.
* **spectrumConfig** *(dict) --* **[REQUIRED]**
Information about the uplink spectral "Config".
* **centerFrequency** *(dict) --* **[REQUIRED]**
Center frequency of an uplink spectral "Config". Valid
values are between 2025 to 2120 MHz.
* **units** *(string) --* **[REQUIRED]**
Frequency units.
* **value** *(float) --* **[REQUIRED]**
Frequency value. Valid values are between 2200 to 2300
MHz and 7750 to 8400 MHz for downlink and 2025 to 2120
MHz for uplink.
* **polarization** *(string) --*
Polarization of an uplink spectral "Config". Capturing
both ""RIGHT_HAND"" and ""LEFT_HAND"" polarization
requires two separate configs.
* **targetEirp** *(dict) --* **[REQUIRED]**
EIRP of the target.
* **units** *(string) --* **[REQUIRED]**
Units of an EIRP.
* **value** *(float) --* **[REQUIRED]**
Value of an EIRP. Valid values are between 20.0 to 50.0
dBW.
* **transmitDisabled** *(boolean) --*
Whether or not uplink transmit is disabled.
* **dataflowEndpointConfig** *(dict) --*
Information about the dataflow endpoint "Config".
* **dataflowEndpointName** *(string) --* **[REQUIRED]**
Name of a dataflow endpoint.
* **dataflowEndpointRegion** *(string) --*
Region of a dataflow endpoint.
* **s3RecordingConfig** *(dict) --*
Information about an S3 recording "Config".
* **bucketArn** *(string) --* **[REQUIRED]**
ARN of the bucket to record to.
* **prefix** *(string) --*
S3 Key prefix to prefice data files.
* **roleArn** *(string) --* **[REQUIRED]**
ARN of the role Ground Station assumes to write data to
the bucket.
* **trackingConfig** *(dict) --*
Object that determines whether tracking should be used
during a contact executed with this "Config" in the mission
profile.
* **autotrack** *(string) --* **[REQUIRED]**
Current setting for autotrack.
* **uplinkEchoConfig** *(dict) --*
Information about an uplink echo "Config".
Parameters from the "AntennaUplinkConfig", corresponding to
the specified "AntennaUplinkConfigArn", are used when this
"UplinkEchoConfig" is used in a contact.
* **antennaUplinkConfigArn** *(string) --* **[REQUIRED]**
ARN of an uplink "Config".
* **enabled** *(boolean) --* **[REQUIRED]**
Whether or not an uplink "Config" is enabled.
* **name** (*string*) --
**[REQUIRED]**
Name of a "Config".
* **tags** (*dict*) --
Tags assigned to a "Config".
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'
}
**Response Structure**
* *(dict) --*
* **configArn** *(string) --*
ARN of a "Config".
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceLimitExceededException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_dataflow_endpoint_groups
list_dataflow_endpoint_groups
*****************************
GroundStation.Client.list_dataflow_endpoint_groups(**kwargs)
Returns a list of "DataflowEndpoint" groups.
See also: AWS API Documentation
**Request Syntax**
response = client.list_dataflow_endpoint_groups(
maxResults=123,
nextToken='string'
)
Parameters:
* **maxResults** (*integer*) -- Maximum number of dataflow
endpoint groups returned.
* **nextToken** (*string*) -- Next token returned in the request
of a previous "ListDataflowEndpointGroups" call. Used to get
the next page of results.
Return type:
dict
Returns:
**Response Syntax**
{
'dataflowEndpointGroupList': [
{
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string'
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **dataflowEndpointGroupList** *(list) --*
A list of dataflow endpoint groups.
* *(dict) --*
Item in a list of "DataflowEndpoint" groups.
* **dataflowEndpointGroupArn** *(string) --*
ARN of a dataflow endpoint group.
* **dataflowEndpointGroupId** *(string) --*
UUID of a dataflow endpoint group.
* **nextToken** *(string) --*
Next token returned in the response of a previous
"ListDataflowEndpointGroups" call. Used to get the next page
of results.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_satellite
get_satellite
*************
GroundStation.Client.get_satellite(**kwargs)
Returns a satellite.
See also: AWS API Documentation
**Request Syntax**
response = client.get_satellite(
satelliteId='string'
)
Parameters:
**satelliteId** (*string*) --
**[REQUIRED]**
UUID of a satellite.
Return type:
dict
Returns:
**Response Syntax**
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
}
**Response Structure**
* *(dict) --*
* **currentEphemeris** *(dict) --*
The current ephemeris being used to compute the trajectory
of the satellite.
* **ephemerisId** *(string) --*
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from
Space Track.
* **epoch** *(datetime) --*
The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided
ephemerides.
* **name** *(string) --*
A name string associated with the ephemeris. Used as a
human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides
that have a name associated.
* **source** *(string) --*
The "EphemerisSource" that generated a given ephemeris.
* **groundStations** *(list) --*
A list of ground stations to which the satellite is on-
boarded.
* *(string) --*
* **noradSatelliteID** *(integer) --*
NORAD satellite ID number.
* **satelliteArn** *(string) --*
ARN of a satellite.
* **satelliteId** *(string) --*
UUID of a satellite.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / delete_ephemeris
delete_ephemeris
****************
GroundStation.Client.delete_ephemeris(**kwargs)
Deletes an ephemeris
See also: AWS API Documentation
**Request Syntax**
response = client.delete_ephemeris(
ephemerisId='string'
)
Parameters:
**ephemerisId** (*string*) --
**[REQUIRED]**
The AWS Ground Station ephemeris ID.
Return type:
dict
Returns:
**Response Syntax**
{
'ephemerisId': 'string'
}
**Response Structure**
* *(dict) --*
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / update_agent_status
update_agent_status
*******************
GroundStation.Client.update_agent_status(**kwargs)
Note:
For use by AWS Ground Station Agent and shouldn't be called
directly.
Update the status of the agent.
See also: AWS API Documentation
**Request Syntax**
response = client.update_agent_status(
agentId='string',
aggregateStatus={
'signatureMap': {
'string': True|False
},
'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
},
componentStatuses=[
{
'bytesReceived': 123,
'bytesSent': 123,
'capabilityArn': 'string',
'componentType': 'string',
'dataflowId': 'string',
'packetsDropped': 123,
'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
},
],
taskId='string'
)
Parameters:
* **agentId** (*string*) --
**[REQUIRED]**
UUID of agent to update.
* **aggregateStatus** (*dict*) --
**[REQUIRED]**
Aggregate status for agent.
* **signatureMap** *(dict) --*
Sparse map of failure signatures.
* *(string) --*
* *(boolean) --*
* **status** *(string) --* **[REQUIRED]**
Aggregate status.
* **componentStatuses** (*list*) --
**[REQUIRED]**
List of component statuses for agent.
* *(dict) --*
Data on the status of agent components.
* **bytesReceived** *(integer) --*
Bytes received by the component.
* **bytesSent** *(integer) --*
Bytes sent by the component.
* **capabilityArn** *(string) --* **[REQUIRED]**
Capability ARN of the component.
* **componentType** *(string) --* **[REQUIRED]**
The Component type.
* **dataflowId** *(string) --* **[REQUIRED]**
Dataflow UUID associated with the component.
* **packetsDropped** *(integer) --*
Packets dropped by component.
* **status** *(string) --* **[REQUIRED]**
Component status.
* **taskId** (*string*) --
**[REQUIRED]**
GUID of agent task.
Return type:
dict
Returns:
**Response Syntax**
{
'agentId': 'string'
}
**Response Structure**
* *(dict) --*
* **agentId** *(string) --*
UUID of updated agent.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / create_ephemeris
create_ephemeris
****************
GroundStation.Client.create_ephemeris(**kwargs)
Creates an Ephemeris with the specified "EphemerisData".
See also: AWS API Documentation
**Request Syntax**
response = client.create_ephemeris(
enabled=True|False,
ephemeris={
'oem': {
'oemData': 'string',
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'tle': {
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'tleData': [
{
'tleLine1': 'string',
'tleLine2': 'string',
'validTimeRange': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
]
}
},
expirationTime=datetime(2015, 1, 1),
kmsKeyArn='string',
name='string',
priority=123,
satelliteId='string',
tags={
'string': 'string'
}
)
Parameters:
* **enabled** (*boolean*) --
Whether to set the ephemeris status to "ENABLED" after
validation.
Setting this to false will set the ephemeris status to
"DISABLED" after validation.
* **ephemeris** (*dict*) --
Ephemeris data.
Note:
This is a Tagged Union structure. Only one of the
following top level keys can be set: "oem", "tle".
* **oem** *(dict) --*
Ephemeris data in Orbit Ephemeris Message (OEM) format.
AWS Ground Station processes OEM Customer Provided
Ephemerides according to the CCSDS standard with some extra
restrictions. OEM files should be in KVN format. For more
detail about the OEM format that AWS Ground Station
supports, see OEM ephemeris format in the AWS Ground Station
user guide.
* **oemData** *(string) --*
The data for an OEM ephemeris, supplied directly in the
request rather than through an S3 object.
* **s3Object** *(dict) --*
Identifies the S3 object to be used as the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for the
ephemeris.
* **tle** *(dict) --*
Two-line element set (TLE) ephemeris.
* **s3Object** *(dict) --*
Identifies the S3 object to be used as the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for the
ephemeris.
* **tleData** *(list) --*
The data for a TLE ephemeris, supplied directly in the
request rather than through an S3 object.
* *(dict) --*
Two-line element set (TLE) data.
* **tleLine1** *(string) --* **[REQUIRED]**
First line of two-line element set (TLE) data.
* **tleLine2** *(string) --* **[REQUIRED]**
Second line of two-line element set (TLE) data.
* **validTimeRange** *(dict) --* **[REQUIRED]**
The valid time range for the TLE. Gaps or overlap are
not permitted.
* **endTime** *(datetime) --* **[REQUIRED]**
Time in UTC at which the time range ends.
* **startTime** *(datetime) --* **[REQUIRED]**
Time in UTC at which the time range starts.
* **expirationTime** (*datetime*) -- An overall expiration time
for the ephemeris in UTC, after which it will become
"EXPIRED".
* **kmsKeyArn** (*string*) -- The ARN of a KMS key used to
encrypt the ephemeris in Ground Station.
* **name** (*string*) --
**[REQUIRED]**
A name string associated with the ephemeris. Used as a human-
readable identifier for the ephemeris.
* **priority** (*integer*) --
Customer-provided priority score to establish the order in
which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and
higher numbers take precedence.
Priority must be 1 or greater
* **satelliteId** (*string*) --
**[REQUIRED]**
AWS Ground Station satellite ID for this ephemeris.
* **tags** (*dict*) --
Tags assigned to an ephemeris.
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'ephemerisId': 'string'
}
**Response Structure**
* *(dict) --*
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_configs
list_configs
************
GroundStation.Client.list_configs(**kwargs)
Returns a list of "Config" objects.
See also: AWS API Documentation
**Request Syntax**
response = client.list_configs(
maxResults=123,
nextToken='string'
)
Parameters:
* **maxResults** (*integer*) -- Maximum number of "Configs"
returned.
* **nextToken** (*string*) -- Next token returned in the request
of a previous "ListConfigs" call. Used to get the next page of
results.
Return type:
dict
Returns:
**Response Syntax**
{
'configList': [
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
'name': 'string'
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **configList** *(list) --*
List of "Config" items.
* *(dict) --*
An item in a list of "Config" objects.
* **configArn** *(string) --*
ARN of a "Config".
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
* **name** *(string) --*
Name of a "Config".
* **nextToken** *(string) --*
Next token returned in the response of a previous
"ListConfigs" call. Used to get the next page of results.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_tags_for_resource
list_tags_for_resource
**********************
GroundStation.Client.list_tags_for_resource(**kwargs)
Returns a list of tags for a specified resource.
See also: AWS API Documentation
**Request Syntax**
response = client.list_tags_for_resource(
resourceArn='string'
)
Parameters:
**resourceArn** (*string*) --
**[REQUIRED]**
ARN of a resource.
Return type:
dict
Returns:
**Response Syntax**
{
'tags': {
'string': 'string'
}
}
**Response Structure**
* *(dict) --*
* **tags** *(dict) --*
Tags assigned to a resource.
* *(string) --*
* *(string) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / register_agent
register_agent
**************
GroundStation.Client.register_agent(**kwargs)
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**
response = 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',
]
},
tags={
'string': 'string'
}
)
Parameters:
* **agentDetails** (*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) --*
* **discoveryData** (*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) --*
* **tags** (*dict*) --
Tags assigned to an "Agent".
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'agentId': 'string'
}
**Response Structure**
* *(dict) --*
* **agentId** *(string) --*
UUID of registered agent.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / untag_resource
untag_resource
**************
GroundStation.Client.untag_resource(**kwargs)
Deassigns a resource tag.
See also: AWS API Documentation
**Request Syntax**
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
Parameters:
* **resourceArn** (*string*) --
**[REQUIRED]**
ARN of a resource.
* **tagKeys** (*list*) --
**[REQUIRED]**
Keys of a resource tag.
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{}
**Response Structure**
* *(dict) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_agent_configuration
get_agent_configuration
***********************
GroundStation.Client.get_agent_configuration(**kwargs)
Note:
For use by AWS Ground Station Agent and shouldn't be called
directly.
Gets the latest configuration information for a registered agent.
See also: AWS API Documentation
**Request Syntax**
response = client.get_agent_configuration(
agentId='string'
)
Parameters:
**agentId** (*string*) --
**[REQUIRED]**
UUID of agent to get configuration information for.
Return type:
dict
Returns:
**Response Syntax**
{
'agentId': 'string',
'taskingDocument': 'string'
}
**Response Structure**
* *(dict) --*
* **agentId** *(string) --*
UUID of agent.
* **taskingDocument** *(string) --*
Tasking document for agent.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_waiter
get_waiter
**********
GroundStation.Client.get_waiter(waiter_name)
Returns an object that can wait for some condition.
Parameters:
**waiter_name** (*str*) -- The name of the waiter to get. See
the waiters section of the service docs for a list of available
waiters.
Returns:
The specified waiter object.
Return type:
"botocore.waiter.Waiter"
GroundStation / Client / delete_dataflow_endpoint_group
delete_dataflow_endpoint_group
******************************
GroundStation.Client.delete_dataflow_endpoint_group(**kwargs)
Deletes a dataflow endpoint group.
See also: AWS API Documentation
**Request Syntax**
response = client.delete_dataflow_endpoint_group(
dataflowEndpointGroupId='string'
)
Parameters:
**dataflowEndpointGroupId** (*string*) --
**[REQUIRED]**
UUID of a dataflow endpoint group.
Return type:
dict
Returns:
**Response Syntax**
{
'dataflowEndpointGroupId': 'string'
}
**Response Structure**
* *(dict) --*
* **dataflowEndpointGroupId** *(string) --*
UUID of a dataflow endpoint group.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_mission_profiles
list_mission_profiles
*********************
GroundStation.Client.list_mission_profiles(**kwargs)
Returns a list of mission profiles.
See also: AWS API Documentation
**Request Syntax**
response = client.list_mission_profiles(
maxResults=123,
nextToken='string'
)
Parameters:
* **maxResults** (*integer*) -- Maximum number of mission
profiles returned.
* **nextToken** (*string*) -- Next token returned in the request
of a previous "ListMissionProfiles" call. Used to get the next
page of results.
Return type:
dict
Returns:
**Response Syntax**
{
'missionProfileList': [
{
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string'
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **missionProfileList** *(list) --*
List of mission profiles.
* *(dict) --*
Item in a list of mission profiles.
* **missionProfileArn** *(string) --*
ARN of a mission profile.
* **missionProfileId** *(string) --*
UUID of a mission profile.
* **name** *(string) --*
Name of a mission profile.
* **region** *(string) --*
Region of a mission profile.
* **nextToken** *(string) --*
Next token returned in the response of a previous
"ListMissionProfiles" call. Used to get the next page of
results.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_ephemerides
list_ephemerides
****************
GroundStation.Client.list_ephemerides(**kwargs)
List existing ephemerides.
See also: AWS API Documentation
**Request Syntax**
response = client.list_ephemerides(
endTime=datetime(2015, 1, 1),
maxResults=123,
nextToken='string',
satelliteId='string',
startTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
]
)
Parameters:
* **endTime** (*datetime*) --
**[REQUIRED]**
The end time to list in UTC. The operation will return an
ephemeris if its expiration time is within the time range
defined by the "startTime" and "endTime".
* **maxResults** (*integer*) -- Maximum number of ephemerides to
return.
* **nextToken** (*string*) -- Pagination token.
* **satelliteId** (*string*) --
**[REQUIRED]**
The AWS Ground Station satellite ID to list ephemeris for.
* **startTime** (*datetime*) --
**[REQUIRED]**
The start time to list in UTC. The operation will return an
ephemeris if its expiration time is within the time range
defined by the "startTime" and "endTime".
* **statusList** (*list*) --
The list of ephemeris status to return.
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'ephemerides': [
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'name': 'string',
'priority': 123,
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **ephemerides** *(list) --*
List of ephemerides.
* *(dict) --*
Ephemeris item.
* **creationTime** *(datetime) --*
The time the ephemeris was uploaded in UTC.
* **enabled** *(boolean) --*
Whether or not the ephemeris is enabled.
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
* **name** *(string) --*
A name string associated with the ephemeris. Used as a
human-readable identifier for the ephemeris.
* **priority** *(integer) --*
Customer-provided priority score to establish the order
in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is
1, and higher numbers take precedence.
Priority must be 1 or greater
* **sourceS3Object** *(dict) --*
Source S3 object used for the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for the
ephemeris.
* **status** *(string) --*
The status of the ephemeris.
* **nextToken** *(string) --*
Pagination token.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / describe_contact
describe_contact
****************
GroundStation.Client.describe_contact(**kwargs)
Describes an existing contact.
See also: AWS API Documentation
**Request Syntax**
response = client.describe_contact(
contactId='string'
)
Parameters:
**contactId** (*string*) --
**[REQUIRED]**
UUID of a contact.
Return type:
dict
Returns:
**Response Syntax**
{
'contactId': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'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': 'HEALTHY'|'UNHEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'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': 'HEALTHY'|'UNHEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'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'
},
'visibilityEndTime': datetime(2015, 1, 1),
'visibilityStartTime': datetime(2015, 1, 1)
}
**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.
Note:
This is a Tagged Union structure. Only one of the
following top level keys will be set:
"antennaDemodDecodeDetails", "endpointDetails",
"s3RecordingDetails". If a client receives an
unknown member it will set "SDK_UNKNOWN_MEMBER"
as the top level key, which maps to the name or
tag of the unknown member. The structure of
"SDK_UNKNOWN_MEMBER" is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
* **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"
Note:
This is a Tagged Union structure. Only one of the
following top level keys will be set:
"antennaDemodDecodeDetails", "endpointDetails",
"s3RecordingDetails". If a client receives an
unknown member it will set "SDK_UNKNOWN_MEMBER"
as the top level key, which maps to the name or
tag of the unknown member. The structure of
"SDK_UNKNOWN_MEMBER" is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
* **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) --*
* **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.
* **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.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_config
get_config
**********
GroundStation.Client.get_config(**kwargs)
Returns "Config" information.
Only one "Config" response can be returned.
See also: AWS API Documentation
**Request Syntax**
response = client.get_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'
)
Parameters:
* **configId** (*string*) --
**[REQUIRED]**
UUID of a "Config".
* **configType** (*string*) --
**[REQUIRED]**
Type of a "Config".
Return type:
dict
Returns:
**Response Syntax**
{
'configArn': 'string',
'configData': {
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording',
'name': 'string',
'tags': {
'string': 'string'
}
}
**Response Structure**
* *(dict) --*
* **configArn** *(string) --*
ARN of a "Config"
* **configData** *(dict) --*
Data elements in a "Config".
Note:
This is a Tagged Union structure. Only one of the
following top level keys will be set:
"antennaDownlinkConfig",
"antennaDownlinkDemodDecodeConfig", "antennaUplinkConfig",
"dataflowEndpointConfig", "s3RecordingConfig",
"trackingConfig", "uplinkEchoConfig". If a client
receives an unknown member it will set
"SDK_UNKNOWN_MEMBER" as the top level key, which maps
to the name or tag of the unknown member. The
structure of "SDK_UNKNOWN_MEMBER" is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
* **antennaDownlinkConfig** *(dict) --*
Information about how AWS Ground Station should configure
an antenna for downlink during a contact.
* **spectrumConfig** *(dict) --*
Object that describes a spectral "Config".
* **bandwidth** *(dict) --*
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **units** *(string) --*
Frequency bandwidth units.
* **value** *(float) --*
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid
values are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are
between 10 kHz to 54 MHz.
* **centerFrequency** *(dict) --*
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --*
Frequency units.
* **value** *(float) --*
Frequency value. Valid values are between 2200 to
2300 MHz and 7750 to 8400 MHz for downlink and 2025
to 2120 MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaDownlinkDemodDecodeConfig** *(dict) --*
Information about how AWS Ground Station should configure
an antenna for downlink demod decode during a contact.
* **decodeConfig** *(dict) --*
Information about the decode "Config".
* **unvalidatedJSON** *(string) --*
Unvalidated JSON of a decode "Config".
* **demodulationConfig** *(dict) --*
Information about the demodulation "Config".
* **unvalidatedJSON** *(string) --*
Unvalidated JSON of a demodulation "Config".
* **spectrumConfig** *(dict) --*
Information about the spectral "Config".
* **bandwidth** *(dict) --*
Bandwidth of a spectral "Config". AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid values
are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig" valid values are between
10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are between
10 kHz to 54 MHz.
* **units** *(string) --*
Frequency bandwidth units.
* **value** *(float) --*
Frequency bandwidth value. AWS Ground Station
currently has the following bandwidth limitations:
* For "AntennaDownlinkDemodDecodeconfig", valid
values are between 125 kHz to 650 MHz.
* For "AntennaDownlinkconfig", valid values are
between 10 kHz to 54 MHz.
* For "AntennaUplinkConfig", valid values are
between 10 kHz to 54 MHz.
* **centerFrequency** *(dict) --*
Center frequency of a spectral "Config". Valid values
are between 2200 to 2300 MHz and 7750 to 8400 MHz for
downlink and 2025 to 2120 MHz for uplink.
* **units** *(string) --*
Frequency units.
* **value** *(float) --*
Frequency value. Valid values are between 2200 to
2300 MHz and 7750 to 8400 MHz for downlink and 2025
to 2120 MHz for uplink.
* **polarization** *(string) --*
Polarization of a spectral "Config". Capturing both
""RIGHT_HAND"" and ""LEFT_HAND"" polarization requires
two separate configs.
* **antennaUplinkConfig** *(dict) --*
Information about how AWS Ground Station should configure
an antenna for uplink during a contact.
* **spectrumConfig** *(dict) --*
Information about the uplink spectral "Config".
* **centerFrequency** *(dict) --*
Center frequency of an uplink spectral "Config". Valid
values are between 2025 to 2120 MHz.
* **units** *(string) --*
Frequency units.
* **value** *(float) --*
Frequency value. Valid values are between 2200 to
2300 MHz and 7750 to 8400 MHz for downlink and 2025
to 2120 MHz for uplink.
* **polarization** *(string) --*
Polarization of an uplink spectral "Config". Capturing
both ""RIGHT_HAND"" and ""LEFT_HAND"" polarization
requires two separate configs.
* **targetEirp** *(dict) --*
EIRP of the target.
* **units** *(string) --*
Units of an EIRP.
* **value** *(float) --*
Value of an EIRP. Valid values are between 20.0 to
50.0 dBW.
* **transmitDisabled** *(boolean) --*
Whether or not uplink transmit is disabled.
* **dataflowEndpointConfig** *(dict) --*
Information about the dataflow endpoint "Config".
* **dataflowEndpointName** *(string) --*
Name of a dataflow endpoint.
* **dataflowEndpointRegion** *(string) --*
Region of a dataflow endpoint.
* **s3RecordingConfig** *(dict) --*
Information about an S3 recording "Config".
* **bucketArn** *(string) --*
ARN of the bucket to record to.
* **prefix** *(string) --*
S3 Key prefix to prefice data files.
* **roleArn** *(string) --*
ARN of the role Ground Station assumes to write data to
the bucket.
* **trackingConfig** *(dict) --*
Object that determines whether tracking should be used
during a contact executed with this "Config" in the
mission profile.
* **autotrack** *(string) --*
Current setting for autotrack.
* **uplinkEchoConfig** *(dict) --*
Information about an uplink echo "Config".
Parameters from the "AntennaUplinkConfig", corresponding
to the specified "AntennaUplinkConfigArn", are used when
this "UplinkEchoConfig" is used in a contact.
* **antennaUplinkConfigArn** *(string) --*
ARN of an uplink "Config".
* **enabled** *(boolean) --*
Whether or not an uplink "Config" is enabled.
* **configId** *(string) --*
UUID of a "Config".
* **configType** *(string) --*
Type of a "Config".
* **name** *(string) --*
Name of a "Config".
* **tags** *(dict) --*
Tags assigned to a "Config".
* *(string) --*
* *(string) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / create_mission_profile
create_mission_profile
**********************
GroundStation.Client.create_mission_profile(**kwargs)
Creates a mission profile.
"dataflowEdges" is a list of lists of strings. Each lower level
list of strings has two elements: a *from* ARN and a *to* ARN.
See also: AWS API Documentation
**Request Syntax**
response = client.create_mission_profile(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
minimumViableContactDurationSeconds=123,
name='string',
streamsKmsKey={
'kmsAliasArn': 'string',
'kmsAliasName': 'string',
'kmsKeyArn': 'string'
},
streamsKmsRole='string',
tags={
'string': 'string'
},
trackingConfigArn='string'
)
Parameters:
* **contactPostPassDurationSeconds** (*integer*) -- Amount of
time after a contact ends that you’d like to receive a Ground
Station Contact State Change event indicating the pass has
finished.
* **contactPrePassDurationSeconds** (*integer*) -- Amount of
time prior to contact start you’d like to receive a Ground
Station Contact State Change event indicating an upcoming
pass.
* **dataflowEdges** (*list*) --
**[REQUIRED]**
A list of lists of ARNs. Each list of ARNs is an edge, with a
*from* "Config" and a *to* "Config".
* *(list) --*
* *(string) --*
* **minimumViableContactDurationSeconds** (*integer*) --
**[REQUIRED]**
Smallest amount of time in seconds that you’d like to see for
an available contact. AWS Ground Station will not present you
with contacts shorter than this duration.
* **name** (*string*) --
**[REQUIRED]**
Name of a mission profile.
* **streamsKmsKey** (*dict*) --
KMS key to use for encrypting streams.
Note:
This is a Tagged Union structure. Only one of the
following top level keys can be set: "kmsAliasArn",
"kmsAliasName", "kmsKeyArn".
* **kmsAliasArn** *(string) --*
KMS Alias Arn.
* **kmsAliasName** *(string) --*
KMS Alias Name.
* **kmsKeyArn** *(string) --*
KMS Key Arn.
* **streamsKmsRole** (*string*) -- Role to use for encrypting
streams with KMS key.
* **tags** (*dict*) --
Tags assigned to a mission profile.
* *(string) --*
* *(string) --*
* **trackingConfigArn** (*string*) --
**[REQUIRED]**
ARN of a tracking "Config".
Return type:
dict
Returns:
**Response Syntax**
{
'missionProfileId': 'string'
}
**Response Structure**
* *(dict) --*
* **missionProfileId** *(string) --*
UUID of a mission profile.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_contacts
list_contacts
*************
GroundStation.Client.list_contacts(**kwargs)
Returns a list of contacts.
If "statusList" contains AVAILABLE, the request must include
"groundStation", "missionprofileArn", and "satelliteArn".
See also: AWS API Documentation
**Request Syntax**
response = client.list_contacts(
endTime=datetime(2015, 1, 1),
groundStation='string',
maxResults=123,
missionProfileArn='string',
nextToken='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
statusList=[
'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
]
)
Parameters:
* **endTime** (*datetime*) --
**[REQUIRED]**
End time of a contact in UTC.
* **groundStation** (*string*) -- Name of a ground station.
* **maxResults** (*integer*) -- Maximum number of contacts
returned.
* **missionProfileArn** (*string*) -- ARN of a mission profile.
* **nextToken** (*string*) -- Next token returned in the request
of a previous "ListContacts" call. Used to get the next page
of results.
* **satelliteArn** (*string*) -- ARN of a satellite.
* **startTime** (*datetime*) --
**[REQUIRED]**
Start time of a contact in UTC.
* **statusList** (*list*) --
**[REQUIRED]**
Status of a contact reservation.
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'contactList': [
{
'contactId': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'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'
},
'visibilityEndTime': datetime(2015, 1, 1),
'visibilityStartTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **contactList** *(list) --*
List of contacts.
* *(dict) --*
Data describing a contact.
* **contactId** *(string) --*
UUID of a contact.
* **contactStatus** *(string) --*
Status of a contact.
* **endTime** *(datetime) --*
End time of a contact in UTC.
* **errorMessage** *(string) --*
Error message of a contact.
* **groundStation** *(string) --*
Name of a ground station.
* **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) --*
* **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. This field is not present for
contacts with a "SCHEDULING" or "SCHEDULED" status.
* **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. This field is not present for
contacts with a "SCHEDULING" or "SCHEDULED" status.
* **nextToken** *(string) --*
Next token returned in the response of a previous
"ListContacts" call. Used to get the next page of results.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / reserve_contact
reserve_contact
***************
GroundStation.Client.reserve_contact(**kwargs)
Reserves a contact using specified parameters.
See also: AWS API Documentation
**Request Syntax**
response = client.reserve_contact(
endTime=datetime(2015, 1, 1),
groundStation='string',
missionProfileArn='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
tags={
'string': 'string'
}
)
Parameters:
* **endTime** (*datetime*) --
**[REQUIRED]**
End time of a contact in UTC.
* **groundStation** (*string*) --
**[REQUIRED]**
Name of a ground station.
* **missionProfileArn** (*string*) --
**[REQUIRED]**
ARN of a mission profile.
* **satelliteArn** (*string*) --
**[REQUIRED]**
ARN of a satellite
* **startTime** (*datetime*) --
**[REQUIRED]**
Start time of a contact in UTC.
* **tags** (*dict*) --
Tags assigned to a contact.
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'contactId': 'string'
}
**Response Structure**
* *(dict) --*
* **contactId** *(string) --*
UUID of a contact.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / update_ephemeris
update_ephemeris
****************
GroundStation.Client.update_ephemeris(**kwargs)
Updates an existing ephemeris
See also: AWS API Documentation
**Request Syntax**
response = client.update_ephemeris(
enabled=True|False,
ephemerisId='string',
name='string',
priority=123
)
Parameters:
* **enabled** (*boolean*) --
**[REQUIRED]**
Whether the ephemeris is enabled or not. Changing this value
will not require the ephemeris to be re-validated.
* **ephemerisId** (*string*) --
**[REQUIRED]**
The AWS Ground Station ephemeris ID.
* **name** (*string*) -- A name string associated with the
ephemeris. Used as a human-readable identifier for the
ephemeris.
* **priority** (*integer*) --
Customer-provided priority score to establish the order in
which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and
higher numbers take precedence.
Priority must be 1 or greater
Return type:
dict
Returns:
**Response Syntax**
{
'ephemerisId': 'string'
}
**Response Structure**
* *(dict) --*
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / delete_mission_profile
delete_mission_profile
**********************
GroundStation.Client.delete_mission_profile(**kwargs)
Deletes a mission profile.
See also: AWS API Documentation
**Request Syntax**
response = client.delete_mission_profile(
missionProfileId='string'
)
Parameters:
**missionProfileId** (*string*) --
**[REQUIRED]**
UUID of a mission profile.
Return type:
dict
Returns:
**Response Syntax**
{
'missionProfileId': 'string'
}
**Response Structure**
* *(dict) --*
* **missionProfileId** *(string) --*
UUID of a mission profile.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / close
close
*****
GroundStation.Client.close()
Closes underlying endpoint connections.
GroundStation / Client / describe_ephemeris
describe_ephemeris
******************
GroundStation.Client.describe_ephemeris(**kwargs)
Describes an existing ephemeris.
See also: AWS API Documentation
**Request Syntax**
response = client.describe_ephemeris(
ephemerisId='string'
)
Parameters:
**ephemerisId** (*string*) --
**[REQUIRED]**
The AWS Ground Station ephemeris ID.
Return type:
dict
Returns:
**Response Syntax**
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
'name': 'string',
'priority': 123,
'satelliteId': 'string',
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
'suppliedData': {
'oem': {
'ephemerisData': 'string',
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'tle': {
'ephemerisData': 'string',
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
}
},
'tags': {
'string': 'string'
}
}
**Response Structure**
* *(dict) --*
* **creationTime** *(datetime) --*
The time the ephemeris was uploaded in UTC.
* **enabled** *(boolean) --*
Whether or not the ephemeris is enabled.
* **ephemerisId** *(string) --*
The AWS Ground Station ephemeris ID.
* **invalidReason** *(string) --*
Reason that an ephemeris failed validation. Only provided
for ephemerides with "INVALID" status.
* **name** *(string) --*
A name string associated with the ephemeris. Used as a
human-readable identifier for the ephemeris.
* **priority** *(integer) --*
Customer-provided priority score to establish the order in
which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1,
and higher numbers take precedence.
Priority must be 1 or greater
* **satelliteId** *(string) --*
The AWS Ground Station satellite ID associated with
ephemeris.
* **status** *(string) --*
The status of the ephemeris.
* **suppliedData** *(dict) --*
Supplied ephemeris data.
Note:
This is a Tagged Union structure. Only one of the
following top level keys will be set: "oem", "tle". If
a client receives an unknown member it will set
"SDK_UNKNOWN_MEMBER" as the top level key, which maps
to the name or tag of the unknown member. The
structure of "SDK_UNKNOWN_MEMBER" is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
* **oem** *(dict) --*
Description of ephemeris.
* **ephemerisData** *(string) --*
Supplied ephemeris data.
* **sourceS3Object** *(dict) --*
Source S3 object used for the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for the
ephemeris.
* **tle** *(dict) --*
Description of ephemeris.
* **ephemerisData** *(string) --*
Supplied ephemeris data.
* **sourceS3Object** *(dict) --*
Source S3 object used for the ephemeris.
* **bucket** *(string) --*
An Amazon S3 Bucket name.
* **key** *(string) --*
An Amazon S3 key for the ephemeris.
* **version** *(string) --*
For versioned S3 objects, the version to use for the
ephemeris.
* **tags** *(dict) --*
Tags assigned to an ephemeris.
* *(string) --*
* *(string) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / list_ground_stations
list_ground_stations
********************
GroundStation.Client.list_ground_stations(**kwargs)
Returns a list of ground stations.
See also: AWS API Documentation
**Request Syntax**
response = client.list_ground_stations(
maxResults=123,
nextToken='string',
satelliteId='string'
)
Parameters:
* **maxResults** (*integer*) -- Maximum number of ground
stations returned.
* **nextToken** (*string*) -- Next token that can be supplied in
the next call to get the next page of ground stations.
* **satelliteId** (*string*) -- Satellite ID to retrieve on-
boarded ground stations.
Return type:
dict
Returns:
**Response Syntax**
{
'groundStationList': [
{
'groundStationId': 'string',
'groundStationName': 'string',
'region': 'string'
},
],
'nextToken': 'string'
}
**Response Structure**
* *(dict) --*
* **groundStationList** *(list) --*
List of ground stations.
* *(dict) --*
Information about the ground station data.
* **groundStationId** *(string) --*
UUID of a ground station.
* **groundStationName** *(string) --*
Name of a ground station.
* **region** *(string) --*
Ground station Region.
* **nextToken** *(string) --*
Next token that can be supplied in the next call to get the
next page of ground stations.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / update_mission_profile
update_mission_profile
**********************
GroundStation.Client.update_mission_profile(**kwargs)
Updates a mission profile.
Updating a mission profile will not update the execution parameters
for existing future contacts.
See also: AWS API Documentation
**Request Syntax**
response = client.update_mission_profile(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
minimumViableContactDurationSeconds=123,
missionProfileId='string',
name='string',
streamsKmsKey={
'kmsAliasArn': 'string',
'kmsAliasName': 'string',
'kmsKeyArn': 'string'
},
streamsKmsRole='string',
trackingConfigArn='string'
)
Parameters:
* **contactPostPassDurationSeconds** (*integer*) -- Amount of
time after a contact ends that you’d like to receive a Ground
Station Contact State Change event indicating the pass has
finished.
* **contactPrePassDurationSeconds** (*integer*) -- Amount of
time after a contact ends that you’d like to receive a Ground
Station Contact State Change event indicating the pass has
finished.
* **dataflowEdges** (*list*) --
A list of lists of ARNs. Each list of ARNs is an edge, with a
*from* "Config" and a *to* "Config".
* *(list) --*
* *(string) --*
* **minimumViableContactDurationSeconds** (*integer*) --
Smallest amount of time in seconds that you’d like to see for
an available contact. AWS Ground Station will not present you
with contacts shorter than this duration.
* **missionProfileId** (*string*) --
**[REQUIRED]**
UUID of a mission profile.
* **name** (*string*) -- Name of a mission profile.
* **streamsKmsKey** (*dict*) --
KMS key to use for encrypting streams.
Note:
This is a Tagged Union structure. Only one of the
following top level keys can be set: "kmsAliasArn",
"kmsAliasName", "kmsKeyArn".
* **kmsAliasArn** *(string) --*
KMS Alias Arn.
* **kmsAliasName** *(string) --*
KMS Alias Name.
* **kmsKeyArn** *(string) --*
KMS Key Arn.
* **streamsKmsRole** (*string*) -- Role to use for encrypting
streams with KMS key.
* **trackingConfigArn** (*string*) -- ARN of a tracking
"Config".
Return type:
dict
Returns:
**Response Syntax**
{
'missionProfileId': 'string'
}
**Response Structure**
* *(dict) --*
* **missionProfileId** *(string) --*
UUID of a mission profile.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / tag_resource
tag_resource
************
GroundStation.Client.tag_resource(**kwargs)
Assigns a tag to a resource.
See also: AWS API Documentation
**Request Syntax**
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
Parameters:
* **resourceArn** (*string*) --
**[REQUIRED]**
ARN of a resource tag.
* **tags** (*dict*) --
**[REQUIRED]**
Tags assigned to a resource.
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{}
**Response Structure**
* *(dict) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_dataflow_endpoint_group
get_dataflow_endpoint_group
***************************
GroundStation.Client.get_dataflow_endpoint_group(**kwargs)
Returns the dataflow endpoint group.
See also: AWS API Documentation
**Request Syntax**
response = client.get_dataflow_endpoint_group(
dataflowEndpointGroupId='string'
)
Parameters:
**dataflowEndpointGroupId** (*string*) --
**[REQUIRED]**
UUID of a dataflow endpoint group.
Return type:
dict
Returns:
**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': 'HEALTHY'|'UNHEALTHY',
'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) --*
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / create_dataflow_endpoint_group
create_dataflow_endpoint_group
******************************
GroundStation.Client.create_dataflow_endpoint_group(**kwargs)
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**
response = 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': 'HEALTHY'|'UNHEALTHY',
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
],
tags={
'string': 'string'
}
)
Parameters:
* **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.
* **endpointDetails** (*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.
* **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) --*
* **tags** (*dict*) --
Tags of a dataflow endpoint group.
* *(string) --*
* *(string) --*
Return type:
dict
Returns:
**Response Syntax**
{
'dataflowEndpointGroupId': 'string'
}
**Response Structure**
* *(dict) --*
* **dataflowEndpointGroupId** *(string) --*
UUID of a dataflow endpoint group.
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"
GroundStation / Client / get_mission_profile
get_mission_profile
*******************
GroundStation.Client.get_mission_profile(**kwargs)
Returns a mission profile.
See also: AWS API Documentation
**Request Syntax**
response = client.get_mission_profile(
missionProfileId='string'
)
Parameters:
**missionProfileId** (*string*) --
**[REQUIRED]**
UUID of a mission profile.
Return type:
dict
Returns:
**Response Syntax**
{
'contactPostPassDurationSeconds': 123,
'contactPrePassDurationSeconds': 123,
'dataflowEdges': [
[
'string',
],
],
'minimumViableContactDurationSeconds': 123,
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string',
'streamsKmsKey': {
'kmsAliasArn': 'string',
'kmsAliasName': 'string',
'kmsKeyArn': 'string'
},
'streamsKmsRole': 'string',
'tags': {
'string': 'string'
},
'trackingConfigArn': 'string'
}
**Response Structure**
* *(dict) --*
* **contactPostPassDurationSeconds** *(integer) --*
Amount of time after a contact ends that you’d like to
receive a CloudWatch event indicating the pass has finished.
* **contactPrePassDurationSeconds** *(integer) --*
Amount of time prior to contact start you’d like to receive
a CloudWatch event indicating an upcoming pass.
* **dataflowEdges** *(list) --*
A list of lists of ARNs. Each list of ARNs is an edge, with
a *from* "Config" and a *to* "Config".
* *(list) --*
* *(string) --*
* **minimumViableContactDurationSeconds** *(integer) --*
Smallest amount of time in seconds that you’d like to see
for an available contact. AWS Ground Station will not
present you with contacts shorter than this duration.
* **missionProfileArn** *(string) --*
ARN of a mission profile.
* **missionProfileId** *(string) --*
UUID of a mission profile.
* **name** *(string) --*
Name of a mission profile.
* **region** *(string) --*
Region of a mission profile.
* **streamsKmsKey** *(dict) --*
KMS key to use for encrypting streams.
Note:
This is a Tagged Union structure. Only one of the
following top level keys will be set: "kmsAliasArn",
"kmsAliasName", "kmsKeyArn". If a client receives an
unknown member it will set "SDK_UNKNOWN_MEMBER" as the
top level key, which maps to the name or tag of the
unknown member. The structure of "SDK_UNKNOWN_MEMBER"
is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
* **kmsAliasArn** *(string) --*
KMS Alias Arn.
* **kmsAliasName** *(string) --*
KMS Alias Name.
* **kmsKeyArn** *(string) --*
KMS Key Arn.
* **streamsKmsRole** *(string) --*
Role to use for encrypting streams with KMS key.
* **tags** *(dict) --*
Tags assigned to a mission profile.
* *(string) --*
* *(string) --*
* **trackingConfigArn** *(string) --*
ARN of a tracking "Config".
**Exceptions**
* "GroundStation.Client.exceptions.InvalidParameterException"
* "GroundStation.Client.exceptions.DependencyException"
* "GroundStation.Client.exceptions.ResourceNotFoundException"