Amazon Relational Database Service
API Reference (API Version 2014-10-31)

StartActivityStream

Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ApplyImmediately

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

Type: Boolean

Required: No

KmsKeyId

The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.

Type: String

Required: Yes

Mode

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Type: String

Valid Values: sync | async

Required: Yes

ResourceArn

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

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

ApplyImmediately

Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

Type: Boolean

KinesisStreamName

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

Type: String

KmsKeyId

The AWS KMS key identifier for encryption of messages in the database activity stream.

Type: String

Mode

The mode of the database activity stream.

Type: String

Valid Values: sync | async

Status

The status of the database activity stream.

Type: String

Valid Values: stopped | starting | started | stopping

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an AWS KMS key.

HTTP Status Code: 400

ResourceNotFoundFault

The specified resource ID was not found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: