modify_event_subscription¶
Operation¶
async
¶
modify_event_subscription(input: ModifyEventSubscriptionInput, plugins: list[Plugin] | None = None) -> ModifyEventSubscriptionOutput
Modifies an existing RDS event notification subscription. You can't
modify the source identifiers using this call. To change source
identifiers for a subscription, use the
AddSourceIdentifierToSubscription and
RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type
(SourceType) in
Events
in the Amazon RDS User Guide or by using the DescribeEventCategories
operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyEventSubscriptionInput
|
An instance of |
required |
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 |
|---|---|
ModifyEventSubscriptionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
enabled: bool | None = ...
Specifies whether to activate the subscription.
class-attribute
instance-attribute
¶
A list of event categories for a source type (SourceType) that you
want to subscribe to. You can see a list of the categories for a given
source type in
Events
in the Amazon RDS User Guide or by using the DescribeEventCategories
operation.
class-attribute
instance-attribute
¶
sns_topic_arn: str | None = ...
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
class-attribute
instance-attribute
¶
source_type: str | None = ...
The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would set
this parameter to db-instance. For RDS Proxy events, specify db-proxy.
If this value isn't specified, all events are returned.
Valid
Values:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyEventSubscriptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Contains the results of a successful invocation of the
DescribeEventSubscriptions action.
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.