Skip to content

get_gateway_rule

Operation

get_gateway_rule

get_gateway_rule(request: GetGatewayRuleInput | GetGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayRuleInputDict]) -> GetGatewayRuleOutput

Retrieves detailed information about a specific gateway rule.

Parameters:

Name Type Description Default
request GetGatewayRuleInput | GetGatewayRuleInputDict | 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[GetGatewayRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGatewayRuleOutput

An instance of GetGatewayRuleOutput.

get_gateway_rule async

get_gateway_rule(request: GetGatewayRuleInput | GetGatewayRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayRuleInputDict]) -> GetGatewayRuleOutput

Retrieves detailed information about a specific gateway rule.

Parameters:

Name Type Description Default
request GetGatewayRuleInput | GetGatewayRuleInputDict | 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[GetGatewayRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGatewayRuleOutput

An instance of GetGatewayRuleOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetGatewayRuleInputDict

Bases: TypedDict

Dictionary form of GetGatewayRuleInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway containing the rule.

rule_id instance-attribute
rule_id: Required[str]

The unique identifier of the rule to retrieve.

GetGatewayRuleInput dataclass

Bases: _SerdeShape

Dataclass for GetGatewayRuleInput structure.

Attributes

gateway_identifier class-attribute instance-attribute
gateway_identifier: str | None = ...

The identifier of the gateway containing the rule.

rule_id class-attribute instance-attribute
rule_id: str | None = ...

The unique identifier of the rule to retrieve.

Output

GetGatewayRuleOutput dataclass

Bases: _SerdeShape

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

Attributes

actions instance-attribute
actions: list[Action]

The actions to take when the rule conditions are met.

conditions class-attribute instance-attribute
conditions: list[Condition] | None = ...

The conditions that must be met for the rule to apply.

created_at instance-attribute
created_at: datetime

The timestamp when the rule was created.

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
response_metadata: ResponseMetadata = ...

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.

rule_id instance-attribute
rule_id: str

The unique identifier of the gateway rule.

status instance-attribute
status: str

The current status of the rule.

system class-attribute instance-attribute
system: SystemManagedBlock | None = ...

System-managed metadata for rules created by automated processes.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The timestamp when the rule was last updated.