:doc:`ControlTower <../../controltower>` / Client / enable_baseline

***************
enable_baseline
***************



.. py:method:: ControlTower.Client.enable_baseline(**kwargs)

  

  Enable (apply) a ``Baseline`` to a Target. This API starts an asynchronous operation to deploy resources specified by the ``Baseline`` to the specified Target. For usage examples, see `the Amazon Web Services Control Tower User Guide <https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableBaseline>`_  


  **Request Syntax**
  ::

    response = client.enable_baseline(
        baselineVersion='string',
        parameters=[
            {
                'key': 'string',
                'value': {...}|[...]|123|123.4|'string'|True|None
            },
        ],
        baselineIdentifier='string',
        targetIdentifier='string',
        tags={
            'string': 'string'
        }
    )
    
  :type baselineVersion: string
  :param baselineVersion: **[REQUIRED]** 

    The specific version to be enabled of the specified baseline.

    

  
  :type parameters: list
  :param parameters: 

    A list of ``key-value`` objects that specify enablement parameters, where ``key`` is a string and ``value`` is a document of any type.

    

  
    - *(dict) --* 

      A key-value parameter to an ``EnabledBaseline`` resource.

      

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

        A string denoting the parameter key.

        

      
      - **value** (:ref:`document<document>`) -- **[REQUIRED]** 

        A low-level ``Document`` object of any type (for example, a Java Object).

        

      
    

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

    The ARN of the baseline to be enabled.

    

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

    The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

    

  
  :type tags: dict
  :param tags: 

    Tags associated with input to ``EnableBaseline``.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'operationIdentifier': 'string',
          'arn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **operationIdentifier** *(string) --* 

        The ID (in UUID format) of the asynchronous ``EnableBaseline`` operation. This ``operationIdentifier`` is used to track status through calls to the ``GetBaselineOperation`` API.

        
      

      - **arn** *(string) --* 

        The ARN of the ``EnabledBaseline`` resource.

        
  
  **Exceptions**
  
  *   :py:class:`ControlTower.Client.exceptions.ConflictException`

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

  
  *   :py:class:`ControlTower.Client.exceptions.ServiceQuotaExceededException`

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

  
  *   :py:class:`ControlTower.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`ControlTower.Client.exceptions.ThrottlingException`

  