RDS / Client / stop_activity_stream

stop_activity_stream#

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 action.

For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

See also: AWS API Documentation

Request Syntax

response = client.stop_activity_stream(
    ResourceArn='string',
    ApplyImmediately=True|False
)
Parameters:

  • ResourceArn (string) –

    [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.

  • ApplyImmediately (boolean) – Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

Return type:

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

  • RDS.Client.exceptions.InvalidDBInstanceStateFault

  • RDS.Client.exceptions.InvalidDBClusterStateFault

  • RDS.Client.exceptions.ResourceNotFoundFault

  • RDS.Client.exceptions.DBClusterNotFoundFault

  • RDS.Client.exceptions.DBInstanceNotFoundFault