AWS Ground Station

2023/01/31 - AWS Ground Station - 3 new 6 updated api methods

Changes  DigIF Expansion changes to the Customer APIs.

GetAgentConfiguration (new) Link ¶

Gets the latest configuration information for a registered agent.

See also: AWS API Documentation

Request Syntax

client.get_agent_configuration(
    agentId='string'
)
type agentId

string

param agentId

[REQUIRED]

UUID of agent to get configuration information for.

rtype

dict

returns

Response Syntax

{
    'agentId': 'string',
    'taskingDocument': 'string'
}

Response Structure

  • (dict) --

    • agentId (string) --

      UUID of agent.

    • taskingDocument (string) --

      Tasking document for agent.

UpdateAgentStatus (new) Link ¶

Update the status of the agent.

See also: AWS API Documentation

Request Syntax

client.update_agent_status(
    agentId='string',
    aggregateStatus={
        'signatureMap': {
            'string': True|False
        },
        'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
    },
    componentStatuses=[
        {
            'bytesReceived': 123,
            'bytesSent': 123,
            'capabilityArn': 'string',
            'componentType': 'LAMINAR_FLOW'|'PRISM'|'DIGITIZER',
            'dataflowId': 'string',
            'packetsDropped': 123,
            'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
        },
    ],
    taskId='string'
)
type agentId

string

param agentId

[REQUIRED]

UUID of agent to update.

type aggregateStatus

dict

param aggregateStatus

[REQUIRED]

Aggregate status for agent.

  • signatureMap (dict) --

    Sparse map of failure signatures.

    • (string) --

      • (boolean) --

  • status (string) -- [REQUIRED]

    Aggregate status.

type componentStatuses

list

param componentStatuses

[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.

type taskId

string

param taskId

[REQUIRED]

GUID of agent task.

rtype

dict

returns

Response Syntax

{
    'agentId': 'string'
}

Response Structure

  • (dict) --

    • agentId (string) --

      UUID of updated agent.

RegisterAgent (new) Link ¶

Registers a new agent with AWS Groundstation.

See also: AWS API Documentation

Request Syntax

client.register_agent(
    agentDetails={
        'agentVersion': 'string',
        'componentVersions': [
            {
                'componentType': 'LAMINAR_FLOW'|'PRISM'|'DIGITIZER',
                'versions': [
                    'string',
                ]
            },
        ],
        'instanceId': 'string',
        'instanceType': 'string',
        'reservedCpuCores': [
            123,
        ]
    },
    discoveryData={
        'capabilityArns': [
            'string',
        ],
        'privateIpAddresses': [
            'string',
        ],
        'publicIpAddresses': [
            'string',
        ]
    }
)
type agentDetails

dict

param agentDetails

[REQUIRED]

Detailed information about the agent being registered.

  • 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) -- [REQUIRED]

    Number of Cpu cores reserved for agent.

    • (integer) --

type discoveryData

dict

param discoveryData

[REQUIRED]

Data for associating and 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) --

rtype

dict

returns

Response Syntax

{
    'agentId': 'string'
}

Response Structure

  • (dict) --

    • agentId (string) --

      UUID of registered agent.

CreateDataflowEndpointGroup (updated) Link ¶
Changes (request)
{'endpointDetails': {'awsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
                                                                      '| '
                                                                      'FAILED '
                                                                      '| '
                                                                      'ACTIVE '
                                                                      '| '
                                                                      'INACTIVE',
                                                       'auditResults': 'HEALTHY '
                                                                       '| '
                                                                       'UNHEALTHY',
                                                       'egressAddress': {'mtu': 'integer',
                                                                         'socketAddress': {'name': 'string',
                                                                                           'port': 'integer'}},
                                                       'ingressAddress': {'mtu': 'integer',
                                                                          'socketAddress': {'name': 'string',
                                                                                            'portRange': {'maximum': 'integer',
                                                                                                          'minimum': 'integer'}}},
                                                       'name': 'string'}}}

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

See also: AWS API Documentation

Request Syntax

client.create_dataflow_endpoint_group(
    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'
            },
            'securityDetails': {
                'roleArn': 'string',
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ]
            }
        },
    ],
    tags={
        'string': 'string'
    }
)
type contactPostPassDurationSeconds

integer

param contactPostPassDurationSeconds

Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.

type contactPrePassDurationSeconds

integer

param contactPrePassDurationSeconds

Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS state.

type endpointDetails

list

param endpointDetails

[REQUIRED]

Endpoint details of each endpoint in the dataflow endpoint group.

  • (dict) --

    Information about the endpoint details.

    • awsGroundStationAgentEndpoint (dict) --

      An agent endpoint.

      • agentStatus (string) --

        The status of AgentEndpoint.

      • auditResults (string) --

        The results of the audit.

      • egressAddress (dict) -- [REQUIRED]

        The egress address of AgentEndpoint.

        • mtu (integer) --

          Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

        • socketAddress (dict) -- [REQUIRED]

          A socket address.

          • name (string) -- [REQUIRED]

            Name of a socket address.

          • port (integer) -- [REQUIRED]

            Port of a socket address.

      • ingressAddress (dict) -- [REQUIRED]

        The ingress address of AgentEndpoint.

        • mtu (integer) --

          Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

        • socketAddress (dict) -- [REQUIRED]

          A ranged socket address.

          • name (string) -- [REQUIRED]

            IPv4 socket address.

          • portRange (dict) -- [REQUIRED]

            Port range of a socket address.

            • maximum (integer) -- [REQUIRED]

              A maximum value.

            • minimum (integer) -- [REQUIRED]

              A minimum value.

      • name (string) -- [REQUIRED]

        Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.

    • endpoint (dict) --

      A dataflow endpoint.

      • address (dict) --

        Socket address of a dataflow endpoint.

        • name (string) -- [REQUIRED]

          Name of a socket address.

        • port (integer) -- [REQUIRED]

          Port of a socket address.

      • mtu (integer) --

        Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

      • name (string) --

        Name of a dataflow endpoint.

      • status (string) --

        Status of a dataflow endpoint.

    • 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) --

type tags

dict

param tags

Tags of a dataflow endpoint group.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'dataflowEndpointGroupId': 'string'
}

Response Structure

  • (dict) --

    • dataflowEndpointGroupId (string) --

      UUID of a dataflow endpoint group.

CreateMissionProfile (updated) Link ¶
Changes (request)
{'streamsKmsKey': {'kmsAliasArn': 'string', 'kmsKeyArn': 'string'},
 'streamsKmsRole': 'string'}

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

client.create_mission_profile(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    dataflowEdges=[
        [
            'string',
        ],
    ],
    minimumViableContactDurationSeconds=123,
    name='string',
    streamsKmsKey={
        'kmsAliasArn': 'string',
        'kmsKeyArn': 'string'
    },
    streamsKmsRole='string',
    tags={
        'string': 'string'
    },
    trackingConfigArn='string'
)
type contactPostPassDurationSeconds

integer

param contactPostPassDurationSeconds

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

type contactPrePassDurationSeconds

integer

param contactPrePassDurationSeconds

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

type dataflowEdges

list

param dataflowEdges

[REQUIRED]

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config .

  • (list) --

    • (string) --

type minimumViableContactDurationSeconds

integer

param minimumViableContactDurationSeconds

[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.

type name

string

param name

[REQUIRED]

Name of a mission profile.

type streamsKmsKey

dict

param streamsKmsKey

KMS key to use for encrypting streams.

  • kmsAliasArn (string) --

    KMS Alias Arn.

  • kmsKeyArn (string) --

    KMS Key Arn.

type streamsKmsRole

string

param streamsKmsRole

Role to use for encrypting streams with KMS key.

type tags

dict

param tags

Tags assigned to a mission profile.

  • (string) --

    • (string) --

type trackingConfigArn

string

param trackingConfigArn

[REQUIRED]

ARN of a tracking Config .

rtype

dict

returns

Response Syntax

{
    'missionProfileId': 'string'
}

Response Structure

  • (dict) --

    • missionProfileId (string) --

      UUID of a mission profile.

DescribeContact (updated) Link ¶
Changes (response)
{'dataflowList': {'destination': {'configDetails': {'endpointDetails': {'awsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
                                                                                                                         '| '
                                                                                                                         'FAILED '
                                                                                                                         '| '
                                                                                                                         'ACTIVE '
                                                                                                                         '| '
                                                                                                                         'INACTIVE',
                                                                                                          'auditResults': 'HEALTHY '
                                                                                                                          '| '
                                                                                                                          'UNHEALTHY',
                                                                                                          'egressAddress': {'mtu': 'integer',
                                                                                                                            'socketAddress': {'name': 'string',
                                                                                                                                              'port': 'integer'}},
                                                                                                          'ingressAddress': {'mtu': 'integer',
                                                                                                                             'socketAddress': {'name': 'string',
                                                                                                                                               'portRange': {'maximum': 'integer',
                                                                                                                                                             'minimum': 'integer'}}},
                                                                                                          'name': 'string'}}}},
                  'source': {'configDetails': {'endpointDetails': {'awsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
                                                                                                                    '| '
                                                                                                                    'FAILED '
                                                                                                                    '| '
                                                                                                                    'ACTIVE '
                                                                                                                    '| '
                                                                                                                    'INACTIVE',
                                                                                                     'auditResults': 'HEALTHY '
                                                                                                                     '| '
                                                                                                                     'UNHEALTHY',
                                                                                                     'egressAddress': {'mtu': 'integer',
                                                                                                                       'socketAddress': {'name': 'string',
                                                                                                                                         'port': 'integer'}},
                                                                                                     'ingressAddress': {'mtu': 'integer',
                                                                                                                        'socketAddress': {'name': 'string',
                                                                                                                                          'portRange': {'maximum': 'integer',
                                                                                                                                                        'minimum': 'integer'}}},
                                                                                                     'name': 'string'}}}}}}

Describes an existing contact.

See also: AWS API Documentation

Request Syntax

client.describe_contact(
    contactId='string'
)
type contactId

string

param contactId

[REQUIRED]

UUID of a contact.

rtype

dict

returns

Response Syntax

{
    'contactId': 'string',
    'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
    'dataflowList': [
        {
            'destination': {
                'configDetails': {
                    'antennaDemodDecodeDetails': {
                        'outputNode': 'string'
                    },
                    'endpointDetails': {
                        'awsGroundStationAgentEndpoint': {
                            'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
                            'auditResults': 'HEALTHY'|'UNHEALTHY',
                            'egressAddress': {
                                'mtu': 123,
                                'socketAddress': {
                                    'name': 'string',
                                    'port': 123
                                }
                            },
                            'ingressAddress': {
                                'mtu': 123,
                                'socketAddress': {
                                    'name': 'string',
                                    'portRange': {
                                        'maximum': 123,
                                        'minimum': 123
                                    }
                                }
                            },
                            'name': 'string'
                        },
                        'endpoint': {
                            'address': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123,
                            'name': 'string',
                            'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
                        },
                        'securityDetails': {
                            'roleArn': 'string',
                            'securityGroupIds': [
                                'string',
                            ],
                            'subnetIds': [
                                'string',
                            ]
                        }
                    },
                    's3RecordingDetails': {
                        'bucketArn': 'string',
                        'keyTemplate': 'string'
                    }
                },
                'configId': 'string',
                'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
                'dataflowDestinationRegion': 'string'
            },
            'errorMessage': 'string',
            'source': {
                'configDetails': {
                    'antennaDemodDecodeDetails': {
                        'outputNode': 'string'
                    },
                    'endpointDetails': {
                        'awsGroundStationAgentEndpoint': {
                            'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
                            'auditResults': 'HEALTHY'|'UNHEALTHY',
                            'egressAddress': {
                                'mtu': 123,
                                'socketAddress': {
                                    'name': 'string',
                                    'port': 123
                                }
                            },
                            'ingressAddress': {
                                'mtu': 123,
                                'socketAddress': {
                                    'name': 'string',
                                    'portRange': {
                                        'maximum': 123,
                                        'minimum': 123
                                    }
                                }
                            },
                            'name': 'string'
                        },
                        'endpoint': {
                            'address': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123,
                            'name': 'string',
                            'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
                        },
                        'securityDetails': {
                            'roleArn': 'string',
                            'securityGroupIds': [
                                'string',
                            ],
                            'subnetIds': [
                                'string',
                            ]
                        }
                    },
                    's3RecordingDetails': {
                        'bucketArn': 'string',
                        'keyTemplate': 'string'
                    }
                },
                'configId': 'string',
                'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
                'dataflowSourceRegion': 'string'
            }
        },
    ],
    'endTime': datetime(2015, 1, 1),
    'errorMessage': 'string',
    'groundStation': 'string',
    'maximumElevation': {
        'unit': 'DEGREE_ANGLE'|'RADIAN',
        'value': 123.0
    },
    'missionProfileArn': 'string',
    'postPassEndTime': datetime(2015, 1, 1),
    'prePassStartTime': datetime(2015, 1, 1),
    'region': 'string',
    'satelliteArn': 'string',
    'startTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • contactId (string) --

      UUID of a contact.

    • contactStatus (string) --

      Status of a contact.

    • dataflowList (list) --

      List describing source and destination details for each dataflow edge.

      • (dict) --

        Information about a dataflow edge used in a contact.

        • destination (dict) --

          Dataflow details for the destination side.

          • configDetails (dict) --

            Additional details for a Config , if type is dataflow endpoint or antenna demod decode.

            • antennaDemodDecodeDetails (dict) --

              Details for antenna demod decode Config in a contact.

              • outputNode (string) --

                Name of an antenna demod decode output node used in a contact.

            • endpointDetails (dict) --

              Information about the endpoint details.

              • awsGroundStationAgentEndpoint (dict) --

                An agent endpoint.

                • agentStatus (string) --

                  The status of AgentEndpoint.

                • auditResults (string) --

                  The results of the audit.

                • egressAddress (dict) --

                  The egress address of AgentEndpoint.

                  • mtu (integer) --

                    Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                  • socketAddress (dict) --

                    A socket address.

                    • name (string) --

                      Name of a socket address.

                    • port (integer) --

                      Port of a socket address.

                • ingressAddress (dict) --

                  The ingress address of AgentEndpoint.

                  • mtu (integer) --

                    Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                  • socketAddress (dict) --

                    A ranged socket address.

                    • name (string) --

                      IPv4 socket address.

                    • portRange (dict) --

                      Port range of a socket address.

                      • maximum (integer) --

                        A maximum value.

                      • minimum (integer) --

                        A minimum value.

                • name (string) --

                  Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.

              • endpoint (dict) --

                A dataflow endpoint.

                • address (dict) --

                  Socket address of a dataflow endpoint.

                  • name (string) --

                    Name of a socket address.

                  • port (integer) --

                    Port of a socket address.

                • mtu (integer) --

                  Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                • name (string) --

                  Name of a dataflow endpoint.

                • status (string) --

                  Status of a dataflow endpoint.

              • securityDetails (dict) --

                Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

                • roleArn (string) --

                  ARN to a role needed for connecting streams to your instances.

                • securityGroupIds (list) --

                  The security groups to attach to the elastic network interfaces.

                  • (string) --

                • subnetIds (list) --

                  A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

                  • (string) --

            • s3RecordingDetails (dict) --

              Details for an S3 recording Config in a contact.

              • bucketArn (string) --

                ARN of the bucket used.

              • keyTemplate (string) --

                Key template used for the S3 Recording Configuration

          • configId (string) --

            UUID of a Config .

          • configType (string) --

            Type of a Config .

          • dataflowDestinationRegion (string) --

            Region of a dataflow destination.

        • errorMessage (string) --

          Error message for a dataflow.

        • source (dict) --

          Dataflow details for the source side.

          • configDetails (dict) --

            Additional details for a Config , if type is dataflow-endpoint or antenna-downlink-demod-decode

            • antennaDemodDecodeDetails (dict) --

              Details for antenna demod decode Config in a contact.

              • outputNode (string) --

                Name of an antenna demod decode output node used in a contact.

            • endpointDetails (dict) --

              Information about the endpoint details.

              • awsGroundStationAgentEndpoint (dict) --

                An agent endpoint.

                • agentStatus (string) --

                  The status of AgentEndpoint.

                • auditResults (string) --

                  The results of the audit.

                • egressAddress (dict) --

                  The egress address of AgentEndpoint.

                  • mtu (integer) --

                    Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                  • socketAddress (dict) --

                    A socket address.

                    • name (string) --

                      Name of a socket address.

                    • port (integer) --

                      Port of a socket address.

                • ingressAddress (dict) --

                  The ingress address of AgentEndpoint.

                  • mtu (integer) --

                    Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                  • socketAddress (dict) --

                    A ranged socket address.

                    • name (string) --

                      IPv4 socket address.

                    • portRange (dict) --

                      Port range of a socket address.

                      • maximum (integer) --

                        A maximum value.

                      • minimum (integer) --

                        A minimum value.

                • name (string) --

                  Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.

              • endpoint (dict) --

                A dataflow endpoint.

                • address (dict) --

                  Socket address of a dataflow endpoint.

                  • name (string) --

                    Name of a socket address.

                  • port (integer) --

                    Port of a socket address.

                • mtu (integer) --

                  Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

                • name (string) --

                  Name of a dataflow endpoint.

                • status (string) --

                  Status of a dataflow endpoint.

              • 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) --

GetDataflowEndpointGroup (updated) Link ¶
Changes (response)
{'endpointsDetails': {'awsGroundStationAgentEndpoint': {'agentStatus': 'SUCCESS '
                                                                       '| '
                                                                       'FAILED '
                                                                       '| '
                                                                       'ACTIVE '
                                                                       '| '
                                                                       'INACTIVE',
                                                        'auditResults': 'HEALTHY '
                                                                        '| '
                                                                        'UNHEALTHY',
                                                        'egressAddress': {'mtu': 'integer',
                                                                          'socketAddress': {'name': 'string',
                                                                                            'port': 'integer'}},
                                                        'ingressAddress': {'mtu': 'integer',
                                                                           'socketAddress': {'name': 'string',
                                                                                             'portRange': {'maximum': 'integer',
                                                                                                           'minimum': 'integer'}}},
                                                        'name': 'string'}}}

Returns the dataflow endpoint group.

See also: AWS API Documentation

Request Syntax

client.get_dataflow_endpoint_group(
    dataflowEndpointGroupId='string'
)
type dataflowEndpointGroupId

string

param dataflowEndpointGroupId

[REQUIRED]

UUID of a dataflow endpoint group.

rtype

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'
            },
            'securityDetails': {
                'roleArn': 'string',
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ]
            }
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • contactPostPassDurationSeconds (integer) --

      Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.

    • contactPrePassDurationSeconds (integer) --

      Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact 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.

        • 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) --

GetMissionProfile (updated) Link ¶
Changes (response)
{'streamsKmsKey': {'kmsAliasArn': 'string', 'kmsKeyArn': 'string'},
 'streamsKmsRole': 'string'}

Returns a mission profile.

See also: AWS API Documentation

Request Syntax

client.get_mission_profile(
    missionProfileId='string'
)
type missionProfileId

string

param missionProfileId

[REQUIRED]

UUID of a mission profile.

rtype

dict

returns

Response Syntax

{
    'contactPostPassDurationSeconds': 123,
    'contactPrePassDurationSeconds': 123,
    'dataflowEdges': [
        [
            'string',
        ],
    ],
    'minimumViableContactDurationSeconds': 123,
    'missionProfileArn': 'string',
    'missionProfileId': 'string',
    'name': 'string',
    'region': 'string',
    'streamsKmsKey': {
        'kmsAliasArn': '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.

      • kmsAliasArn (string) --

        KMS Alias Arn.

      • 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 .

UpdateMissionProfile (updated) Link ¶
Changes (request)
{'streamsKmsKey': {'kmsAliasArn': 'string', 'kmsKeyArn': 'string'},
 'streamsKmsRole': 'string'}

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

client.update_mission_profile(
    contactPostPassDurationSeconds=123,
    contactPrePassDurationSeconds=123,
    dataflowEdges=[
        [
            'string',
        ],
    ],
    minimumViableContactDurationSeconds=123,
    missionProfileId='string',
    name='string',
    streamsKmsKey={
        'kmsAliasArn': 'string',
        'kmsKeyArn': 'string'
    },
    streamsKmsRole='string',
    trackingConfigArn='string'
)
type contactPostPassDurationSeconds

integer

param contactPostPassDurationSeconds

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

type contactPrePassDurationSeconds

integer

param contactPrePassDurationSeconds

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

type dataflowEdges

list

param dataflowEdges

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config .

  • (list) --

    • (string) --

type minimumViableContactDurationSeconds

integer

param minimumViableContactDurationSeconds

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.

type missionProfileId

string

param missionProfileId

[REQUIRED]

UUID of a mission profile.

type name

string

param name

Name of a mission profile.

type streamsKmsKey

dict

param streamsKmsKey

KMS key to use for encrypting streams.

  • kmsAliasArn (string) --

    KMS Alias Arn.

  • kmsKeyArn (string) --

    KMS Key Arn.

type streamsKmsRole

string

param streamsKmsRole

Role to use for encrypting streams with KMS key.

type trackingConfigArn

string

param trackingConfigArn

ARN of a tracking Config .

rtype

dict

returns

Response Syntax

{
    'missionProfileId': 'string'
}

Response Structure

  • (dict) --

    • missionProfileId (string) --

      UUID of a mission profile.