Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Creates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.

post/gateways/{gatewayIdentifier}/rules

Path parameters

gatewayIdentifierstring required

The identifier of the gateway to create a rule for.

Request body

clientTokenstring

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.

priorityinteger required

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.

descriptionstring

The description of the gateway rule.

Response

Success

ruleIdstring required

The unique identifier of the gateway rule.

gatewayArnstring required

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

priorityinteger required

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

descriptionstring

The description of the gateway rule.

createdAtstring date-time required

The timestamp when the rule was created.

status'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' required

The current status of the rule.