:doc:`RDS <../../rds>` / Client / stop_activity_stream

********************
stop_activity_stream
********************



.. py:method:: RDS.Client.stop_activity_stream(**kwargs)

  

  Stops a database activity stream that was started using the Amazon Web Services console, the ``start-activity-stream`` CLI command, or the ``StartActivityStream`` operation.

   

  For more information, see `Monitoring Amazon Aurora with Database Activity Streams <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html>`__ in the *Amazon Aurora User Guide* or `Monitoring Amazon RDS with Database Activity Streams <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html>`__ in the *Amazon RDS User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopActivityStream>`_  


  **Request Syntax**
  ::

    response = client.stop_activity_stream(
        ResourceArn='string',
        ApplyImmediately=True|False
    )
    
  :type ResourceArn: string
  :param ResourceArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, ``arn:aws:rds:us-east-1:12345667890:cluster:das-cluster``.

    

  
  :type ApplyImmediately: boolean
  :param ApplyImmediately: 

    Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

    

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

    
    ::

      {
          'KmsKeyId': 'string',
          'KinesisStreamName': 'string',
          'Status': 'stopped'|'starting'|'started'|'stopping'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **KmsKeyId** *(string) --* 

        The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

         

        The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

        
      

      - **KinesisStreamName** *(string) --* 

        The name of the Amazon Kinesis data stream used for the database activity stream.

        
      

      - **Status** *(string) --* 

        The status of the database activity stream.

        
  
  **Exceptions**
  
  *   :py:class:`RDS.Client.exceptions.ResourceNotFoundFault`

  
  *   :py:class:`RDS.Client.exceptions.DBInstanceNotFoundFault`

  
  *   :py:class:`RDS.Client.exceptions.InvalidDBClusterStateFault`

  
  *   :py:class:`RDS.Client.exceptions.InvalidDBInstanceStateFault`

  
  *   :py:class:`RDS.Client.exceptions.DBClusterNotFoundFault`

  