update_gateway_rule¶
Operation¶
update_gateway_rule
¶
update_gateway_rule(request: UpdateGatewayRuleInput | UpdateGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayRuleInputDict]) -> UpdateGatewayRuleOutput
Updates a gateway rule's priority, conditions, actions, or description.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateGatewayRuleInput | UpdateGatewayRuleInputDict | 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[UpdateGatewayRuleInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateGatewayRuleOutput
|
An instance of |
update_gateway_rule
async
¶
update_gateway_rule(request: UpdateGatewayRuleInput | UpdateGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayRuleInputDict]) -> UpdateGatewayRuleOutput
Updates a gateway rule's priority, conditions, actions, or description.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateGatewayRuleInput | UpdateGatewayRuleInputDict | 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[UpdateGatewayRuleInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateGatewayRuleOutput
|
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.
UpdateGatewayRuleInputDict
¶
Bases: TypedDict
Dictionary form of UpdateGatewayRuleInput.
Attributes¶
actions
instance-attribute
¶
actions: Sequence[Action | ActionDict] | None
The updated actions for the rule.
conditions
instance-attribute
¶
conditions: Sequence[Condition | ConditionDict] | None
The updated conditions for the rule.
gateway_identifier
instance-attribute
¶
The identifier of the gateway containing the rule.
UpdateGatewayRuleInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGatewayRuleInput structure.
Attributes¶
actions
class-attribute
instance-attribute
¶
The updated actions for the rule.
conditions
class-attribute
instance-attribute
¶
The updated conditions for the rule.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The updated description of the rule.
gateway_identifier
class-attribute
instance-attribute
¶
gateway_identifier: str | None = ...
The identifier of the gateway containing the rule.
Output¶
UpdateGatewayRuleOutput
dataclass
¶
Bases: _SerdeShape
Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.
Attributes¶
actions
instance-attribute
¶
The actions to take when the rule conditions are met.
conditions
class-attribute
instance-attribute
¶
The conditions that must be met for the rule to apply.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the gateway rule.
gateway_arn
instance-attribute
¶
gateway_arn: str
The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
priority
instance-attribute
¶
priority: int
The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
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.
system
class-attribute
instance-attribute
¶
system: SystemManagedBlock | None = ...
System-managed metadata for rules created by automated processes.