:doc:`Redshift <../../redshift>` / Client / enable_logging

**************
enable_logging
**************



.. py:method:: Redshift.Client.enable_logging(**kwargs)

  

  Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EnableLogging>`_  


  **Request Syntax**
  ::

    response = client.enable_logging(
        ClusterIdentifier='string',
        BucketName='string',
        S3KeyPrefix='string',
        LogDestinationType='s3'|'cloudwatch',
        LogExports=[
            'string',
        ]
    )
    
  :type ClusterIdentifier: string
  :param ClusterIdentifier: **[REQUIRED]** 

    The identifier of the cluster on which logging is to be started.

     

    Example: ``examplecluster``

    

  
  :type BucketName: string
  :param BucketName: 

    The name of an existing S3 bucket where the log files are to be stored.

     

    Constraints:

     

    
    * Must be in the same region as the cluster
     
    * The cluster must have read bucket and put object permissions
    

    

  
  :type S3KeyPrefix: string
  :param S3KeyPrefix: 

    The prefix applied to the log file names.

     

    Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( ``_``), period ( ``.``), colon ( ``:``), slash ( ``/``), equal ( ``=``), plus ( ``+``), backslash ( ``\``), hyphen ( ``-``), at symbol ( ``@``).

    

  
  :type LogDestinationType: string
  :param LogDestinationType: 

    The log destination type. An enum with possible values of ``s3`` and ``cloudwatch``.

    

  
  :type LogExports: list
  :param LogExports: 

    The collection of exported log types. Possible values are ``connectionlog``, ``useractivitylog``, and ``userlog``.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'LoggingEnabled': True|False,
          'BucketName': 'string',
          'S3KeyPrefix': 'string',
          'LastSuccessfulDeliveryTime': datetime(2015, 1, 1),
          'LastFailureTime': datetime(2015, 1, 1),
          'LastFailureMessage': 'string',
          'LogDestinationType': 's3'|'cloudwatch',
          'LogExports': [
              'string',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Describes the status of logging for a cluster.

      
      

      - **LoggingEnabled** *(boolean) --* 

        ``true`` if logging is on, ``false`` if logging is off.

        
      

      - **BucketName** *(string) --* 

        The name of the S3 bucket where the log files are stored.

        
      

      - **S3KeyPrefix** *(string) --* 

        The prefix applied to the log file names.

        
      

      - **LastSuccessfulDeliveryTime** *(datetime) --* 

        The last time that logs were delivered.

        
      

      - **LastFailureTime** *(datetime) --* 

        The last time when logs failed to be delivered.

        
      

      - **LastFailureMessage** *(string) --* 

        The message indicating that logs failed to be delivered.

        
      

      - **LogDestinationType** *(string) --* 

        The log destination type. An enum with possible values of ``s3`` and ``cloudwatch``.

        
      

      - **LogExports** *(list) --* 

        The collection of exported log types. Possible values are ``connectionlog``, ``useractivitylog``, and ``userlog``.

        
        

        - *(string) --* 
    
  
  **Exceptions**
  
  *   :py:class:`Redshift.Client.exceptions.ClusterNotFoundFault`

  
  *   :py:class:`Redshift.Client.exceptions.BucketNotFoundFault`

  
  *   :py:class:`Redshift.Client.exceptions.InsufficientS3BucketPolicyFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidS3KeyPrefixFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidS3BucketNameFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidClusterStateFault`

  
  *   :py:class:`Redshift.Client.exceptions.UnsupportedOperationFault`

  