Skip to content

RDS  >  Operations  >  stop_activity_stream

stop_activity_stream

Operation

stop_activity_stream async 

stop_activity_stream(input: StopActivityStreamInput, plugins: list[Plugin] | None = None) -> StopActivityStreamOutput

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 in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
input StopActivityStreamInput

An instance of StopActivityStreamInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StopActivityStreamOutput

An instance of StopActivityStreamOutput.

Input

StopActivityStreamInput dataclass

Bases: _SerdeShape

Dataclass for StopActivityStreamInput structure.

Attributes

apply_immediately class-attribute instance-attribute 
apply_immediately: bool | None = ...

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

resource_arn class-attribute instance-attribute 
resource_arn: str | None = ...

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.

Output

StopActivityStreamOutput dataclass

Bases: _SerdeShape

Dataclass for StopActivityStreamOutput structure.

Attributes

kinesis_stream_name class-attribute instance-attribute 
kinesis_stream_name: str | None = ...

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

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = ...

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute 
status: str | None = ...

The status of the database activity stream.