RDS / Client / modify_activity_stream

modify_activity_stream#

RDS.Client.modify_activity_stream(**kwargs)#

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn’t required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.

This operation is supported for RDS for Oracle and Microsoft SQL Server.

See also: AWS API Documentation

Request Syntax

response = client.modify_activity_stream(
    ResourceArn='string',
    AuditPolicyState='locked'|'unlocked'
)
Parameters:

  • ResourceArn (string) – The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

  • AuditPolicyState (string) – The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

Return type:

dict

Returns:

Response Syntax

{
    'KmsKeyId': 'string',
    'KinesisStreamName': 'string',
    'Status': 'stopped'|'starting'|'started'|'stopping',
    'Mode': 'sync'|'async',
    'EngineNativeAuditFieldsIncluded': True|False,
    'PolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}

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 modification to the database activity stream.

    • Mode (string) –

      The mode of the database activity stream.

    • EngineNativeAuditFieldsIncluded (boolean) –

      Indicates whether engine-native audit fields are included in the database activity stream.

    • PolicyStatus (string) –

      The status of the modification to the policy state of the database activity stream.

Exceptions

  • RDS.Client.exceptions.InvalidDBInstanceStateFault

  • RDS.Client.exceptions.ResourceNotFoundFault

  • RDS.Client.exceptions.DBInstanceNotFoundFault