AWS Ground Station

{'contactStatus': {'AWS_FAILED'}, 'dataflowList': {'errorMessage': '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': {
                        'endpoint': {
                            'address': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123,
                            'name': 'string',
                            'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
                        },
                        'securityDetails': {
                            'roleArn': 'string',
                            'securityGroupIds': [
                                'string',
                            ],
                            'subnetIds': [
                                'string',
                            ]
                        }
                    }
                },
                'configId': 'string',
                'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo',
                'dataflowDestinationRegion': 'string'
            },
            'errorMessage': 'string',
            'source': {
                'configDetails': {
                    'antennaDemodDecodeDetails': {
                        'outputNode': 'string'
                    },
                    'endpointDetails': {
                        'endpoint': {
                            'address': {
                                'name': 'string',
                                'port': 123
                            },
                            'mtu': 123,
                            'name': 'string',
                            'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
                        },
                        'securityDetails': {
                            'roleArn': 'string',
                            'securityGroupIds': [
                                'string',
                            ],
                            'subnetIds': [
                                'string',
                            ]
                        }
                    }
                },
                'configId': 'string',
                'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo',
                '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.

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

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

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

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

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

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

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

  • tags (dict) --

    Tags assigned to a contact.

    • (string) --

      • (string) --

{'statusList': {'AWS_FAILED'}}

{'contactList': {'contactStatus': {'AWS_FAILED'}}}

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn .

See also: AWS API Documentation

Request Syntax

client.list_contacts(
    endTime=datetime(2015, 1, 1),
    groundStation='string',
    maxResults=123,
    missionProfileArn='string',
    nextToken='string',
    satelliteArn='string',
    startTime=datetime(2015, 1, 1),
    statusList=[
        'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
    ]
)

type endTime

datetime

param endTime

[REQUIRED]

End time of a contact.

type groundStation

string

param groundStation

Name of a ground station.

type maxResults

integer

param maxResults

Maximum number of contacts returned.

type missionProfileArn

string

param missionProfileArn

ARN of a mission profile.

type nextToken

string

param nextToken

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

type satelliteArn

string

param satelliteArn

ARN of a satellite.

type startTime

datetime

param startTime

[REQUIRED]

Start time of a contact.

type statusList

list

param statusList

[REQUIRED]

Status of a contact reservation.

• (string) --

rtype

dict

returns

Response Syntax

{
    'contactList': [
        {
            'contactId': 'string',
            'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
            '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'
            }
        },
    ],
    '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.

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

      • tags (dict) --

        Tags assigned to a contact.

        • (string) --

          • (string) --

  • nextToken (string) --

    Next token returned in the response of a previous ListContacts call. Used to get the next page of results.