stop_activity_stream ¶

def stop_activity_stream(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    resource_arn: Optional["capo_rds.types.string.String"] = None,
    apply_immediately: Optional[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_rds.types.stop_activity_stream_response.StopActivityStreamResponse":
    """<p>Stops a database activity stream that was started using the Amazon Web Services console, the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html"> Monitoring Amazon Aurora with Database Activity Streams</a> in the <i>Amazon Aurora User Guide</i> or <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html"> Monitoring Amazon RDS with Database Activity Streams</a> in the <i>Amazon RDS User Guide</i>.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, <code>arn:aws:rds:us-east-1:12345667890:cluster:das-cluster</code>.</p>
        apply_immediately: <p>Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.</p>

    Raises:
        capo_rds.errors.db_cluster_not_found_fault.DBClusterNotFoundFault: <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
        capo_rds.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
        capo_rds.errors.invalid_db_cluster_state_fault.InvalidDBClusterStateFault: <p>The requested operation can't be performed while the cluster is in this state.</p>
        capo_rds.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p>The DB instance isn't in a valid state.</p>
        capo_rds.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The specified resource ID was not found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To stop a database activity stream
        The following example stops an activity stream in an Aurora cluster named my-pg-cluster.

        >>> client.stop_activity_stream(resource_arn='arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster', apply_immediately=True)
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.stop_activity_stream_request.StopActivityStreamRequest]",
    ) -> OperationResponse[
        "capo_rds.types.stop_activity_stream_response.StopActivityStreamResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.stop_activity_stream

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.stop_activity_stream.stop_activity_stream(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopActivityStream")
    )
    input_: capo_rds.types.stop_activity_stream_request.StopActivityStreamRequest = {}
    if resource_arn is not None:
        input_["resource_arn"] = resource_arn
    if apply_immediately is not None:
        input_["apply_immediately"] = apply_immediately

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output