View a markdown version of this page

GatewayRuleDetail - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GatewayRuleDetail

Detailed information about a gateway rule.

Contents

actions

The actions to take when the rule conditions are met.

Type: Array of Action objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

createdAt

The timestamp when the rule was created.

Type: Timestamp

Required: Yes

gatewayArn

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

Type: String

Pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}

Required: Yes

priority

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000000.

Required: Yes

ruleId

The unique identifier of the gateway rule.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

status

The current status of the rule.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING

Required: Yes

conditions

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

Type: Array of Condition objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

description

The description of the gateway rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

system

System-managed metadata for rules created by automated processes.

Type: SystemManagedBlock object

Required: No

updatedAt

The timestamp when the rule was last updated.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: