Bedrock Agentcore Control  >  Operations  >  get_gateway_rule

get_gateway_rule

Operation

get_gateway_rule async

get_gateway_rule(input: GetGatewayRuleInput, plugins: list[Plugin] | None = None) -> GetGatewayRuleOutput

Retrieves detailed information about a specific gateway rule.

Parameters:

Name	Type	Description	Default
input	GetGatewayRuleInput	An instance of GetGatewayRuleInput.	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
GetGatewayRuleOutput	An instance of GetGatewayRuleOutput.

Input

GetGatewayRuleInput dataclass

Dataclass for GetGatewayRuleInput structure.

Attributes

gateway_identifier class-attribute instance-attribute

gateway_identifier: str | None = None

The identifier of the gateway containing the rule.

rule_id class-attribute instance-attribute

rule_id: str | None = None

The unique identifier of the rule to retrieve.

Output

GetGatewayRuleOutput dataclass

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 = 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 = 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.

rule_id instance-attribute

rule_id: str

The unique identifier of the gateway rule.

status instance-attribute

status: GatewayRuleStatus

The current status of the rule.

system class-attribute instance-attribute

system: SystemManagedBlock | None = None

System-managed metadata for rules created by automated processes.

updated_at class-attribute instance-attribute

updated_at: datetime | None = None

The timestamp when the rule was last updated.