GroundStation / Client / cancel_contact

cancel_contact

GroundStation.Client.cancel_contact(**kwargs)

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.

For contacts that:

  • Have yet to start, the contact will be cancelled.

  • Have started but have yet to finish, the contact will be stopped.

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