GroundStation / Client / list_contacts

list_contacts¶

GroundStation.Client.list_contacts(**kwargs)¶

Returns a list of contacts.

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

Request Syntax

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

Parameters:

maxResults (integer) – Maximum number of contacts returned.
nextToken (string) – Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
statusList (list) –
[REQUIRED]

Status of a contact reservation.
- (string) –
startTime (datetime) –
[REQUIRED]

Start time of a contact in UTC.
endTime (datetime) –
[REQUIRED]

End time of a contact in UTC.
groundStation (string) – Name of a ground station.
satelliteArn (string) – ARN of a satellite.
missionProfileArn (string) – ARN of a mission profile.
ephemeris (dict) –
Filter for selecting contacts that use a specific ephemeris”.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: azEl.
- azEl (dict) –
  
  Filter for AzElEphemeris.
  - id (string) – [REQUIRED]
    
    Unique identifier of the azimuth elevation ephemeris.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'contactList': [
        {
            'contactId': 'string',
            'missionProfileArn': 'string',
            'satelliteArn': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'prePassStartTime': datetime(2015, 1, 1),
            'postPassEndTime': datetime(2015, 1, 1),
            'groundStation': 'string',
            'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
            'errorMessage': 'string',
            'maximumElevation': {
                'value': 123.0,
                'unit': 'DEGREE_ANGLE'|'RADIAN'
            },
            'region': 'string',
            'tags': {
                'string': 'string'
            },
            'visibilityStartTime': datetime(2015, 1, 1),
            'visibilityEndTime': datetime(2015, 1, 1),
            'ephemeris': {
                'ephemerisId': 'string',
                'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
            },
            'version': {
                '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) –

Output for the ListContacts operation.
- nextToken (string) –
  
  Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
- contactList (list) –
  
  List of contacts.
  - (dict) –
    
    Data describing a contact.
    - contactId (string) –
      
      UUID of a contact.
    - missionProfileArn (string) –
      
      ARN of a mission profile.
    - satelliteArn (string) –
      
      ARN of a satellite.
    - startTime (datetime) –
      
      Start time of a contact in UTC.
    - endTime (datetime) –
      
      End time of a contact in UTC.
    - prePassStartTime (datetime) –
      
      Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
    - postPassEndTime (datetime) –
      
      End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
    - groundStation (string) –
      
      Name of a ground station.
    - contactStatus (string) –
      
      Status of a contact.
    - errorMessage (string) –
      
      Error message of a contact.
    - maximumElevation (dict) –
      
      Maximum elevation angle of a contact.
      - value (float) –
        
        Elevation angle value.
      - unit (string) –
        
        Elevation angle units.
    - region (string) –
      
      Region of a contact.
    - tags (dict) –
      
      Tags assigned to a contact.
      - (string) –
        
        (string) –
    - visibilityStartTime (datetime) –
      
      Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
    - visibilityEndTime (datetime) –
      
      Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
    - ephemeris (dict) –
      
      The ephemeris that determines antenna pointing for the contact.
      - ephemerisId (string) –
        
        Unique identifier of the ephemeris. Appears only for custom ephemerides.
      - ephemerisType (string) –
        
        Type of ephemeris.
    - version (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.

list_contacts¶

Request Syntax

Note

Response Syntax

Response Structure

Exceptions