:doc:`OpenSearchService <../../opensearch>` / Client / start_service_software_update

*****************************
start_service_software_update
*****************************



.. py:method:: OpenSearchService.Client.start_service_software_update(**kwargs)

  

  Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see `Service software updates in Amazon OpenSearch Service <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdate>`_  


  **Request Syntax**
  ::

    response = client.start_service_software_update(
        DomainName='string',
        ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW',
        DesiredStartTime=123
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of the domain that you want to update to the latest service software.

    

  
  :type ScheduleAt: string
  :param ScheduleAt: 

    When to start the service software update.

     

    
    * ``NOW`` - Immediately schedules the update to happen in the current hour if there's capacity available.
     
    * ``TIMESTAMP`` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for ``DesiredStartTime``.
     
    * ``OFF_PEAK_WINDOW`` - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
    

     

    Default: ``NOW`` if you don't specify a value for ``DesiredStartTime``, and ``TIMESTAMP`` if you do.

    

  
  :type DesiredStartTime: integer
  :param DesiredStartTime: 

    The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ``ScheduleAt`` to ``TIMESTAMP``.

    

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

    
    ::

      {
          'ServiceSoftwareOptions': {
              'CurrentVersion': 'string',
              'NewVersion': 'string',
              'UpdateAvailable': True|False,
              'Cancellable': True|False,
              'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
              'Description': 'string',
              'AutomatedUpdateDate': datetime(2015, 1, 1),
              'OptionalDeployment': True|False
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``StartServiceSoftwareUpdate`` operation. Contains the status of the update.

      
      

      - **ServiceSoftwareOptions** *(dict) --* 

        The current status of the OpenSearch Service software update.

        
        

        - **CurrentVersion** *(string) --* 

          The current service software version present on the domain.

          
        

        - **NewVersion** *(string) --* 

          The new service software version, if one is available.

          
        

        - **UpdateAvailable** *(boolean) --* 

          True if you're able to update your service software version. False if you can't update your service software version.

          
        

        - **Cancellable** *(boolean) --* 

          True if you're able to cancel your service software version update. False if you can't cancel your service software update.

          
        

        - **UpdateStatus** *(string) --* 

          The status of your service software update.

          
        

        - **Description** *(string) --* 

          A description of the service software update status.

          
        

        - **AutomatedUpdateDate** *(datetime) --* 

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          
        

        - **OptionalDeployment** *(boolean) --* 

          True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

          
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.BaseException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

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

  
  *   :py:class:`OpenSearchService.Client.exceptions.ValidationException`

  