Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

post/rules/{InstanceId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

Request body

Namestring required

A unique name for the rule.

Functionstring required

The conditions of the rule.

PublishStatus'DRAFT' | 'PUBLISHED' required

The publish status of the rule.

ClientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

Response

Success

RuleArnstring required

The Amazon Resource Name (ARN) of the rule.

RuleIdstring required

A unique identifier for the rule.