RDS / Client / start_activity_stream

start_activity_stream#

RDS.Client.start_activity_stream(**kwargs)#

Starts a database activity stream to monitor activity on the database. 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.start_activity_stream(
    ResourceArn='string',
    Mode='sync'|'async',
    KmsKeyId='string',
    ApplyImmediately=True|False,
    EngineNativeAuditFieldsIncluded=True|False
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

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

  • Mode (string) –

    [REQUIRED]

    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.

  • KmsKeyId (string) –

    [REQUIRED]

    The Amazon Web Services KMS key identifier 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.

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

  • EngineNativeAuditFieldsIncluded (boolean) – Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

Return type:

dict

Returns:

Response Syntax

{
    'KmsKeyId': 'string',
    'KinesisStreamName': 'string',
    'Status': 'stopped'|'starting'|'started'|'stopping',
    'Mode': 'sync'|'async',
    'ApplyImmediately': True|False,
    'EngineNativeAuditFieldsIncluded': True|False
}

Response Structure

  • (dict) –

    • KmsKeyId (string) –

      The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

    • KinesisStreamName (string) –

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

    • Status (string) –

      The status of the database activity stream.

    • Mode (string) –

      The mode of the database activity stream.

    • ApplyImmediately (boolean) –

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

    • EngineNativeAuditFieldsIncluded (boolean) –

      Indicates whether engine-native audit fields are included in 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

  • RDS.Client.exceptions.KMSKeyNotAccessibleFault