静的設定バンドルオーバーライドを使用してルールを作成するキャッチオールのデフォルトルールを作成する加重設定バンドルを分割してルールを作成するターゲットルーティングを使用してルールを作成する加重ターゲットルーティングを使用してルールを作成する条件とアクションを組み合わせたルールを作成するゲートウェイルールを取得するゲートウェイルールを更新するゲートウェイルールを一覧表示するゲートウェイルールを削除する

ゲートウェイルール API の例

次の例は、CLI と AWS Python SDK (Boto3) AWS を使用してゲートウェイルールを管理する方法を示しています。

静的設定バンドルオーバーライドを使用してルールを作成する

次の例では、特定の IAM プリンシパルを設定バンドルバージョンにピン留めするルールを作成します。このアプローチを QA またはデバッグに使用します。

例

AWS CLI

次のコマンドを実行します。


aws bedrock-agentcore-control create-gateway-rule \
    --gateway-identifier my-gateway-abc1234567 \
    --priority 100 \
    --description "Pin QA role to bundle version" \
    --conditions '[
        {
            "matchPrincipals": {
                "anyOf": [
                    {
                        "iamPrincipal": {
                            "arn": "arn:aws:iam::123456789012:role/QARole",
                            "operator": "StringEquals"
                        }
                    }
                ]
            }
        }
    ]' \
    --actions '[
        {
            "configurationBundle": {
                "staticOverride": {
                    "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                    "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab"
                }
            }
        }
    ]'

AWS Python SDK (Boto3)


import boto3

client = boto3.client("bedrock-agentcore-control", region_name="us-west-2")

response = client.create_gateway_rule(
    gatewayIdentifier="my-gateway-abc1234567",
    priority=100,
    description="Pin QA role to bundle version",
    conditions=[
        {
            "matchPrincipals": {
                "anyOf": [
                    {
                        "iamPrincipal": {
                            "arn": "arn:aws:iam::123456789012:role/QARole",
                            "operator": "StringEquals",
                        }
                    }
                ]
            }
        }
    ],
    actions=[
        {
            "configurationBundle": {
                "staticOverride": {
                    "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                    "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab",
                }
            }
        }
    ],
)

print(f"Rule ID: {response['ruleId']}")

キャッチオールのデフォルトルールを作成する

次の例では、条件のないルールを作成します。このルールはすべてのトラフィックに一致し、デフォルトとして機能します。より具体的なルールが優先されるように、優先度の高い数値を割り当てます。

例

加重設定バンドルを分割してルールを作成する

次の例では、A/B テスト用に 2 つの設定バンドルバージョン間でトラフィックを分割するルールを作成します。この例では、トラフィックの 80% がバリアント A を使用し、20% がバリアント B を使用します。

例

AWS CLI

次のコマンドを実行します。


aws bedrock-agentcore-control create-gateway-rule \
    --gateway-identifier my-gateway-abc1234567 \
    --priority 500 \
    --description "A/B test: 80/20 traffic split" \
    --actions '[
        {
            "configurationBundle": {
                "weightedOverride": {
                    "trafficSplit": [
                        {
                            "name": "variant-a",
                            "weight": 80,
                            "configurationBundle": {
                                "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                                "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab"
                            },
                            "description": "Control variant"
                        },
                        {
                            "name": "variant-b",
                            "weight": 20,
                            "configurationBundle": {
                                "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                                "bundleVersion": "12345678-1234-5678-9abc-123456789012"
                            },
                            "description": "Treatment variant"
                        }
                    ]
                }
            }
        }
    ]'

AWS Python SDK (Boto3)


import boto3

client = boto3.client("bedrock-agentcore-control", region_name="us-west-2")

response = client.create_gateway_rule(
    gatewayIdentifier="my-gateway-abc1234567",
    priority=500,
    description="A/B test: 80/20 traffic split",
    actions=[
        {
            "configurationBundle": {
                "weightedOverride": {
                    "trafficSplit": [
                        {
                            "name": "variant-a",
                            "weight": 80,
                            "configurationBundle": {
                                "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                                "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab",
                            },
                            "description": "Control variant",
                        },
                        {
                            "name": "variant-b",
                            "weight": 20,
                            "configurationBundle": {
                                "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                                "bundleVersion": "12345678-1234-5678-9abc-123456789012",
                            },
                            "description": "Treatment variant",
                        },
                    ]
                }
            }
        }
    ],
)

print(f"Rule ID: {response['ruleId']}")

注記

A/B テスト中に一貫したユーザーエクスペリエンスを維持するには、ゲートウェイ呼び出しリクエストに X-Amzn-Bedrock-AgentCore-Runtime-Session-Idヘッダーを含めます。詳細については、「加重ルールのセッション維持」を参照してください。

ターゲットルーティングを使用してルールを作成する

次のの例では、特定のパスパターンに一致するリクエストをターゲットにルーティングするルールを作成します。

例

加重ターゲットルーティングを使用してルールを作成する

次の例では、2 つのターゲット間でトラフィックを分割するルールを作成します。この例では、トラフィックの 90% がプライマリターゲットに、10% が Canary ターゲットにルーティングされます。

例

AWS CLI

次のコマンドを実行します。


aws bedrock-agentcore-control create-gateway-rule \
    --gateway-identifier my-gateway-abc1234567 \
    --priority 300 \
    --description "Canary deployment: 90/10 target split" \
    --actions '[
        {
            "routeToTarget": {
                "weightedRoute": {
                    "trafficSplit": [
                        {
                            "name": "primary",
                            "weight": 90,
                            "targetName": "my-target-primary",
                            "description": "Primary target"
                        },
                        {
                            "name": "canary",
                            "weight": 10,
                            "targetName": "my-target-canary",
                            "description": "Canary target"
                        }
                    ]
                }
            }
        }
    ]'

AWS Python SDK (Boto3)


import boto3

client = boto3.client("bedrock-agentcore-control", region_name="us-west-2")

response = client.create_gateway_rule(
    gatewayIdentifier="my-gateway-abc1234567",
    priority=300,
    description="Canary deployment: 90/10 target split",
    actions=[
        {
            "routeToTarget": {
                "weightedRoute": {
                    "trafficSplit": [
                        {
                            "name": "primary",
                            "weight": 90,
                            "targetName": "my-target-primary",
                            "description": "Primary target",
                        },
                        {
                            "name": "canary",
                            "weight": 10,
                            "targetName": "my-target-canary",
                            "description": "Canary target",
                        },
                    ]
                }
            }
        }
    ],
)

print(f"Rule ID: {response['ruleId']}")

条件とアクションを組み合わせたルールを作成する

次の例では、両方の条件タイプと両方のアクションタイプを持つルールを作成します。リクエストは、各条件タイプから少なくとも 1 つのエントリと一致する必要があります (タイプ間で AND ロジック）。

例

AWS CLI

次のコマンドを実行します。


aws bedrock-agentcore-control create-gateway-rule \
    --gateway-identifier my-gateway-abc1234567 \
    --priority 50 \
    --description "QA role on /my-target-canary paths: pin bundle and route to canary" \
    --conditions '[
        {
            "matchPrincipals": {
                "anyOf": [
                    {
                        "iamPrincipal": {
                            "arn": "arn:aws:iam::123456789012:role/QARole",
                            "operator": "StringEquals"
                        }
                    }
                ]
            }
        },
        {
            "matchPaths": {
                "anyOf": [
                    "/my-target-canary/*"
                ]
            }
        }
    ]' \
    --actions '[
        {
            "configurationBundle": {
                "staticOverride": {
                    "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                    "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab"
                }
            }
        },
        {
            "routeToTarget": {
                "staticRoute": {
                    "targetName": "my-target-canary"
                }
            }
        }
    ]'

AWS Python SDK (Boto3)


import boto3

client = boto3.client("bedrock-agentcore-control", region_name="us-west-2")

response = client.create_gateway_rule(
    gatewayIdentifier="my-gateway-abc1234567",
    priority=50,
    description="QA role on /my-target-canary paths: pin bundle and route to canary",
    conditions=[
        {
            "matchPrincipals": {
                "anyOf": [
                    {
                        "iamPrincipal": {
                            "arn": "arn:aws:iam::123456789012:role/QARole",
                            "operator": "StringEquals",
                        }
                    }
                ]
            }
        },
        {
            "matchPaths": {
                "anyOf": ["/my-target-canary/*"]
            },
        },
    ],
    actions=[
        {
            "configurationBundle": {
                "staticOverride": {
                    "bundleArn": "arn:aws:bedrock-agentcore:us-west-2:123456789012:configuration-bundle/myBundle-abc1234567",
                    "bundleVersion": "1234abcd-12ab-34cd-56ef-1234567890ab",
                }
            }
        },
        {
            "routeToTarget": {
                "staticRoute": {
                    "targetName": "my-target-canary",
                }
            }
        },
    ],
)

print(f"Rule ID: {response['ruleId']}")

注記

このルールは、発信者が QA ロールであり、リクエストパスがと一致する場合にのみ一致します/my-target-canary/*。両方の条件を満たす必要があります。

ゲートウェイルールを取得する

次のの例では、特定のゲートウェイルールの詳細を取得します。

例

ゲートウェイルールを更新する

次のの例では、既存のゲートウェイルールの優先度と説明を更新します。

例

ゲートウェイルールを一覧表示する

次のの例では、ゲートウェイのすべてのルールを一覧表示します。結果は優先順位で昇順にソートされます。

例

ゲートウェイルールを削除する

次のの例では、ゲートウェイルールを削除します。

例

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

セッションの維持

きめ細かなアクセスコントロール