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

***************
reserve_contact
***************



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

  

  Reserves a contact using specified parameters.

  

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


  **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'
                }
            }
        }
    )
    
  :type missionProfileArn: string
  :param missionProfileArn: **[REQUIRED]** 

    ARN of a mission profile.

    

  
  :type satelliteArn: string
  :param satelliteArn: 

    ARN of a satellite

    

  
  :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: **[REQUIRED]** 

    Name of a ground station.

    

  
  :type tags: dict
  :param tags: 

    Tags assigned to a contact.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type trackingOverrides: dict
  :param trackingOverrides: 

    Tracking configuration overrides for the contact.

    

  
    - **programTrackSettings** *(dict) --* **[REQUIRED]** 

      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``. 

    
      - **azEl** *(dict) --* 

        Program track settings for  AzElEphemeris.

        

      
        - **ephemerisId** *(string) --* **[REQUIRED]** 

          Unique identifier of the azimuth elevation ephemeris.

          

        
      
    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'contactId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **contactId** *(string) --* 

        UUID of a contact.

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

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

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

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

  