GroundStation / Client / update_contact

update_contact

GroundStation.Client.update_contact(**kwargs)

Updates a specific contact.

See also: AWS API Documentation

Request Syntax

response = client.update_contact(
    contactId='string',
    clientToken='string',
    trackingOverrides={
        'programTrackSettings': {
            'azEl': {
                'ephemerisId': 'string'
            },
            'oem': {
                'ephemerisId': 'string'
            },
            'tle': {
                'ephemerisId': 'string'
            }
        }
    },
    satelliteArn='string'
)
Parameters:

  • contactId (string) –

    [REQUIRED]

    UUID of a contact.

  • clientToken (string) –

    A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.

    This field is autopopulated if not provided.

  • trackingOverrides (dict) –

    Overrides the default tracking configuration on an antenna during a contact.

    • programTrackSettings (dict) –

      Program track settings to override for antenna tracking during the contact.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: azEl, oem, tle.

      • azEl (dict) –

        Program track settings for AzElEphemeris.

        • ephemerisId (string) – [REQUIRED]

          Unique identifier of the azimuth elevation ephemeris.

      • oem (dict) –

        Program track settings for OEMEphemeris.

        • ephemerisId (string) – [REQUIRED]

          Unique identifier of the OEM ephemeris.

      • tle (dict) –

        Program track settings for TLEEphemeris.

        • ephemerisId (string) – [REQUIRED]

          Unique identifier of the TLE ephemeris.

  • satelliteArn (string) – ARN of a satellite.

Return type:

dict

Returns:

Response Syntax

{
    'contactId': 'string',
    'versionId': 123
}

Response Structure

  • (dict) –

    • contactId (string) –

      UUID of a contact.

    • versionId (integer) –

      Version ID of a contact.

Exceptions