describe_pending_maintenance_actions¶
Operation¶
describe_pending_maintenance_actions
¶
describe_pending_maintenance_actions(request: DescribePendingMaintenanceActionsInput | DescribePendingMaintenanceActionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePendingMaintenanceActionsInputDict]) -> DescribePendingMaintenanceActionsOutput
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the
result of the DescribePendingMaintenanceActions command might not be
immediately visible to all subsequent RDS commands. Keep this in mind
when you use DescribePendingMaintenanceActions immediately after using
a previous API command such as ApplyPendingMaintenanceActions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribePendingMaintenanceActionsInput | DescribePendingMaintenanceActionsInputDict | 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[DescribePendingMaintenanceActionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribePendingMaintenanceActionsOutput
|
An instance of |
describe_pending_maintenance_actions
async
¶
describe_pending_maintenance_actions(request: DescribePendingMaintenanceActionsInput | DescribePendingMaintenanceActionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePendingMaintenanceActionsInputDict]) -> DescribePendingMaintenanceActionsOutput
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the
result of the DescribePendingMaintenanceActions command might not be
immediately visible to all subsequent RDS commands. Keep this in mind
when you use DescribePendingMaintenanceActions immediately after using
a previous API command such as ApplyPendingMaintenanceActions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribePendingMaintenanceActionsInput | DescribePendingMaintenanceActionsInputDict | 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[DescribePendingMaintenanceActionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribePendingMaintenanceActionsOutput
|
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.
DescribePendingMaintenanceActionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribePendingMaintenanceActionsInput.
Attributes¶
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
-
db-cluster-id- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs. -
db-instance-id- Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
marker
instance-attribute
¶
marker: str | None
An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is
specified, the response includes only records beyond the marker, up to a
number of records specified by MaxRecords.
max_records
instance-attribute
¶
max_records: int | None
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribePendingMaintenanceActionsInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
filters
class-attribute
instance-attribute
¶
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
-
db-cluster-id- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs. -
db-instance-id- Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is
specified, the response includes only records beyond the marker, up to a
number of records specified by MaxRecords.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Output¶
DescribePendingMaintenanceActionsOutput
dataclass
¶
Bases: _SerdeShape
Data returned from the DescribePendingMaintenanceActions action.
Attributes¶
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is
specified, the response includes only records beyond the marker, up to a
number of records specified by MaxRecords.
pending_maintenance_actions
class-attribute
instance-attribute
¶
pending_maintenance_actions: list[ResourcePendingMaintenanceActions] | None = ...
A list of the pending maintenance actions for the 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.