:doc:`AppConfigData <../../appconfigdata>` / Client / start_configuration_session

***************************
start_configuration_session
***************************



.. py:method:: AppConfigData.Client.start_configuration_session(**kwargs)

  

  Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that show how to use it with the  GetLatestConfiguration API action, see `Retrieving the configuration <http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration>`__ in the *AppConfig User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSession>`_  


  **Request Syntax**
  ::

    response = client.start_configuration_session(
        ApplicationIdentifier='string',
        EnvironmentIdentifier='string',
        ConfigurationProfileIdentifier='string',
        RequiredMinimumPollIntervalInSeconds=123
    )
    
  :type ApplicationIdentifier: string
  :param ApplicationIdentifier: **[REQUIRED]** 

    The application ID or the application name.

    

  
  :type EnvironmentIdentifier: string
  :param EnvironmentIdentifier: **[REQUIRED]** 

    The environment ID or the environment name.

    

  
  :type ConfigurationProfileIdentifier: string
  :param ConfigurationProfileIdentifier: **[REQUIRED]** 

    The configuration profile ID or the configuration profile name.

    

  
  :type RequiredMinimumPollIntervalInSeconds: integer
  :param RequiredMinimumPollIntervalInSeconds: 

    Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that established the session can't call  GetLatestConfiguration more frequently than every 60 seconds.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **InitialConfigurationToken** *(string) --* 

        Token encapsulating state about the configuration session. Provide this token to the ``GetLatestConfiguration`` API to retrieve configuration data.

         

        .. warning::

           

          This token should only be used once in your first call to ``GetLatestConfiguration``. You *must* use the new token in the ``GetLatestConfiguration`` response ( ``NextPollConfigurationToken``) in each subsequent call to ``GetLatestConfiguration``.

           

          The ``InitialConfigurationToken`` and ``NextPollConfigurationToken`` should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a ``GetLatestConfiguration`` call uses an expired token, the system returns ``BadRequestException``.

          

        
  
  **Exceptions**
  
  *   :py:class:`AppConfigData.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`AppConfigData.Client.exceptions.BadRequestException`

  
  *   :py:class:`AppConfigData.Client.exceptions.InternalServerException`

  