start_activity_stream¶
Operation¶
start_activity_stream
async
¶
start_activity_stream(request: StartActivityStreamInput | StartActivityStreamInputDict, /, *, plugins: list[Plugin] | None = None) -> StartActivityStreamOutput
start_activity_stream(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartActivityStreamInputDict]) -> StartActivityStreamOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
StartActivityStreamOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
StartActivityStreamInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartActivityStreamInput structure.
Attributes¶
apply_immediately
class-attribute
instance-attribute
¶
apply_immediately: bool | None = ...
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
engine_native_audit_fields_included
class-attribute
instance-attribute
¶
engine_native_audit_fields_included: bool | None = ...
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.
kms_key_id
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
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.
Dictionaries¶
StartActivityStreamInputDict
¶
Bases: TypedDict
Dictionary form of StartActivityStreamInput.
Attributes¶
apply_immediately
instance-attribute
¶
apply_immediately: bool | None
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
engine_native_audit_fields_included
instance-attribute
¶
engine_native_audit_fields_included: bool | None
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.
kms_key_id
instance-attribute
¶
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.
mode
instance-attribute
¶
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.
Output¶
StartActivityStreamOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartActivityStreamOutput structure.
Attributes¶
apply_immediately
class-attribute
instance-attribute
¶
apply_immediately: bool | None = ...
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
engine_native_audit_fields_included
class-attribute
instance-attribute
¶
engine_native_audit_fields_included: bool | None = ...
Indicates whether engine-native audit fields are included in the database activity stream.
kinesis_stream_name
class-attribute
instance-attribute
¶
kinesis_stream_name: str | None = ...
The name of the Amazon Kinesis data stream to be 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 for encryption of messages in the database activity stream.
mode
class-attribute
instance-attribute
¶
mode: str | None = ...
The mode of the database activity stream.
response_metadata
class-attribute
instance-attribute
¶
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.