apply_pending_maintenance_action¶
Operation¶
apply_pending_maintenance_action
¶
apply_pending_maintenance_action(request: ApplyPendingMaintenanceActionInput | ApplyPendingMaintenanceActionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ApplyPendingMaintenanceActionInputDict]) -> ApplyPendingMaintenanceActionOutput
Applies a pending maintenance action to a resource (for example, to a DB instance).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ApplyPendingMaintenanceActionInput | ApplyPendingMaintenanceActionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ApplyPendingMaintenanceActionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ApplyPendingMaintenanceActionOutput
|
An instance of |
apply_pending_maintenance_action
async
¶
apply_pending_maintenance_action(request: ApplyPendingMaintenanceActionInput | ApplyPendingMaintenanceActionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ApplyPendingMaintenanceActionInputDict]) -> ApplyPendingMaintenanceActionOutput
Applies a pending maintenance action to a resource (for example, to a DB instance).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ApplyPendingMaintenanceActionInput | ApplyPendingMaintenanceActionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ApplyPendingMaintenanceActionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ApplyPendingMaintenanceActionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ApplyPendingMaintenanceActionInputDict
¶
Bases: TypedDict
Dictionary form of ApplyPendingMaintenanceActionInput.
Attributes¶
apply_action
instance-attribute
¶
The pending maintenance action to apply to this resource.
Valid Values:
-
ca-certificate-rotation -
db-upgrade -
hardware-maintenance -
os-upgrade -
system-update
For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.
opt_in_type
instance-attribute
¶
A value that specifies the type of opt-in request, or undoes an opt-in
request. An opt-in request of type immediate can't be undone.
Valid Values:
-
immediate- Apply the maintenance action immediately. -
next-maintenance- Apply the maintenance action during the next maintenance window for the resource. -
undo-opt-in- Cancel any existingnext-maintenanceopt-in requests.
resource_identifier
instance-attribute
¶
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
ApplyPendingMaintenanceActionInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
apply_action
class-attribute
instance-attribute
¶
apply_action: str | None = ...
The pending maintenance action to apply to this resource.
Valid Values:
-
ca-certificate-rotation -
db-upgrade -
hardware-maintenance -
os-upgrade -
system-update
For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS.
opt_in_type
class-attribute
instance-attribute
¶
opt_in_type: str | None = ...
A value that specifies the type of opt-in request, or undoes an opt-in
request. An opt-in request of type immediate can't be undone.
Valid Values:
-
immediate- Apply the maintenance action immediately. -
next-maintenance- Apply the maintenance action during the next maintenance window for the resource. -
undo-opt-in- Cancel any existingnext-maintenanceopt-in requests.
resource_identifier
class-attribute
instance-attribute
¶
resource_identifier: str | None = ...
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
Output¶
ApplyPendingMaintenanceActionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ApplyPendingMaintenanceActionOutput structure.
Attributes¶
resource_pending_maintenance_actions
class-attribute
instance-attribute
¶
resource_pending_maintenance_actions: ResourcePendingMaintenanceActions | None = ...
Describes the pending maintenance actions for a resource.
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.