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(
    missionProfileArn='string',
    satelliteArn='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    groundStation='string',
    tags={
        'string': 'string'
    },
    trackingOverrides={
        'programTrackSettings': {
            'azEl': {
                'ephemerisId': 'string'
            },
            'oem': {
                'ephemerisId': 'string'
            },
            'tle': {
                'ephemerisId': 'string'
            }
        }
    }
)
Parameters:

  • missionProfileArn (string) –

    [REQUIRED]

    ARN of a mission profile.

  • satelliteArn (string) – ARN of a satellite

  • startTime (datetime) –

    [REQUIRED]

    Start time of a contact in UTC.

  • endTime (datetime) –

    [REQUIRED]

    End time of a contact in UTC.

  • groundStation (string) –

    [REQUIRED]

    Name of a ground station.

  • tags (dict) –

    Tags assigned to a contact.

    • (string) –

      • (string) –

  • trackingOverrides (dict) –

    Tracking configuration overrides for the 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Response containing the ID of a contact.

    • contactId (string) –

      UUID of a contact.

    • versionId (integer) –

      Version ID of a contact.

Exceptions