GroundStation / Client / list_contact_versions

list_contact_versions

GroundStation.Client.list_contact_versions(**kwargs)

Returns a list of versions for a specified contact.

See also: AWS API Documentation

Request Syntax

response = client.list_contact_versions(
    contactId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • contactId (string) –

    [REQUIRED]

    UUID of a contact.

  • maxResults (integer) – Maximum number of contact versions returned.

  • nextToken (string) – Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'contactVersionsList': [
        {
            'versionId': 123,
            'created': datetime(2015, 1, 1),
            'activated': datetime(2015, 1, 1),
            'superseded': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1),
            'status': 'UPDATING'|'ACTIVE'|'SUPERSEDED'|'FAILED_TO_UPDATE',
            'failureCodes': [
                'INTERNAL_ERROR'|'INVALID_SATELLITE_ARN'|'INVALID_UPDATE_CONTACT_REQUEST'|'EPHEMERIS_NOT_FOUND'|'EPHEMERIS_TIME_RANGE_INVALID'|'EPHEMERIS_NOT_ENABLED'|'SATELLITE_DOES_NOT_MATCH_EPHEMERIS'|'NOT_ONBOARDED_TO_AZEL_EPHEMERIS'|'AZEL_EPHEMERIS_NOT_FOUND'|'AZEL_EPHEMERIS_WRONG_GROUND_STATION'|'AZEL_EPHEMERIS_INVALID_STATUS'|'AZEL_EPHEMERIS_TIME_RANGE_INVALID',
            ],
            'failureMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Next token to be used in a subsequent ListContactVersions call to retrieve the next page of results.

    • contactVersionsList (list) –

      List of contact versions.

      • (dict) –

        Version information for a contact.

        • versionId (integer) –

          Version ID of a contact.

        • created (datetime) –

          Time the contact version was created in UTC.

        • activated (datetime) –

          Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.

        • superseded (datetime) –

          Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.

        • lastUpdated (datetime) –

          Time the contact version was last updated in UTC.

        • status (string) –

          Status of the contact version.

        • failureCodes (list) –

          List of failure codes for the contact version.

          • (string) –

        • failureMessage (string) –

          Failure message for the contact version.

Exceptions