:doc:`GroundStation <../../groundstation>` / Client / list_contacts

*************
list_contacts
*************



.. py:method:: GroundStation.Client.list_contacts(**kwargs)

  

  Returns a list of contacts.

   

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListContacts>`_  


  **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'
            }
        }
    )
    
  :type maxResults: integer
  :param maxResults: 

    Maximum number of contacts returned.

    

  
  :type nextToken: string
  :param nextToken: 

    Next token returned in the request of a previous ``ListContacts`` call. Used to get the next page of results.

    

  
  :type statusList: list
  :param statusList: **[REQUIRED]** 

    Status of a contact reservation.

    

  
    - *(string) --* 

    

  :type startTime: datetime
  :param startTime: **[REQUIRED]** 

    Start time of a contact in UTC.

    

  
  :type endTime: datetime
  :param endTime: **[REQUIRED]** 

    End time of a contact in UTC.

    

  
  :type groundStation: string
  :param groundStation: 

    Name of a ground station.

    

  
  :type satelliteArn: string
  :param satelliteArn: 

    ARN of a satellite.

    

  
  :type missionProfileArn: string
  :param missionProfileArn: 

    ARN of a mission profile.

    

  
  :type ephemeris: dict
  :param ephemeris: 

    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.

        

      
    
  
  
  :rtype: 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'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **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) --* 

            Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

            
          

          - **postPassEndTime** *(datetime) --* 

            Amount of time after a contact ends that you’d like to 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 <https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html>`__. 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 <https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html>`__. 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.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`GroundStation.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`GroundStation.Client.exceptions.DependencyException`

  
  *   :py:class:`GroundStation.Client.exceptions.ResourceNotFoundException`

  