get-gateway-rule¶

Description¶

Retrieves detailed information about a specific gateway rule.

Synopsis¶

  get-gateway-rule
--gateway-identifier <value>
--rule-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--gateway-identifier (string) [required]

The identifier of the gateway containing the rule.

Constraints:

pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

--rule-id (string) [required]

The unique identifier of the rule to retrieve.

Constraints:

min: 36

max: 36

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

ruleId -> (string)

The unique identifier of the gateway rule.

Constraints:

min: 36

max: 36

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

gatewayArn -> (string)

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

Constraints:

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}

priority -> (integer)

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

Constraints:

min: 1

max: 1000000

conditions -> (list)

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

Constraints:

min: 0

max: 3

(tagged union structure)

A condition that determines when a gateway rule applies. Conditions can match on principals, request paths, or the requested model.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: matchPrincipals, matchPaths, matchModels.

matchPrincipals -> (structure)

A condition that matches on the identity of the caller making the request.

anyOf -> (list) [required]

A list of principal entries. The condition is met if any of the entries match the caller’s identity.

Constraints:

min: 1

max: 100

(tagged union structure)

Union for principal matching. Currently supports IAM principal ARN glob matching.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: iamPrincipal.

iamPrincipal -> (structure)

An IAM principal to match against, specified by ARN.

arn -> (string) [required]

The Amazon Resource Name (ARN) of the IAM principal. Supports user, role, and assumed-role ARNs. Wildcards can be used with the StringLike operator.

Constraints:

min: 0

max: 2048

pattern: (arn:aws[a-zA-Z-]*:iam::(\d{12}|\*):(user|role)/[\w+=,.@*?/-]+|arn:aws[a-zA-Z-]*:sts::(\d{12}|\*):assumed-role/[\w+=,.@*?/-]+)

operator -> (string)

The match operator. StringEquals requires an exact match. StringLike supports wildcard patterns using * and ? .

Possible values:

StringEquals

StringLike

matchPaths -> (structure)

A condition that matches on the request path.

anyOf -> (list) [required]

A list of path patterns. The condition is met if the request path matches any of the patterns.

Constraints:

min: 1

max: 10

(string)

Constraints:

min: 0

max: 512

pattern: /[\w\-.]+/\*

matchModels -> (structure)

A condition that matches on the model requested in an inference request.

anyOf -> (list) [required]

A list of model entries. The condition is met if the requested model matches any of the entries.

Constraints:

min: 1

max: 100

(structure)

A model ID or pattern to match against the requested model, and the operator to use for the comparison.

value -> (string) [required]

The model ID or pattern to match. With the StringLike operator, you can use * and ? as wildcards, for example anthropic.claude-* .

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9\-\._\*\?@:]+(/[a-zA-Z0-9\-\._\*\?@:]+)*

operator -> (string)

The operator to use when comparing the requested model to the value:

StringEquals – Requires an exact match.

StringLike – Supports wildcard patterns using * and ? . This is the default.

Possible values:

StringEquals

StringLike

actions -> (list)

The actions to take when the rule conditions are met.

Constraints:

min: 1

max: 2

(tagged union structure)

An action to take when a gateway rule’s conditions are met.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: configurationBundle, routeToTarget.

configurationBundle -> (tagged union structure)

An action that applies a configuration bundle override to the request.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: staticOverride, weightedOverride.

staticOverride -> (structure)

A static configuration bundle override that applies a single bundle version to all matching requests.

bundleArn -> (string) [required]

The Amazon Resource Name (ARN) of the configuration bundle to apply.

Constraints:

pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

bundleVersion -> (string) [required]

The version of the configuration bundle to apply.

Constraints:

pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

weightedOverride -> (structure)

A weighted configuration bundle override that splits traffic between multiple bundle versions based on configured weights.

trafficSplit -> (list) [required]

The traffic split entries defining how traffic is distributed between configuration bundle versions.

Constraints:

min: 2

max: 2

(structure)

An entry in a traffic split configuration, defining a named variant with a weight and configuration bundle reference.

name -> (string) [required]

The name of this traffic split variant.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?

weight -> (integer) [required]

The percentage of traffic to route to this variant. Weights across all entries must sum to 100.

Constraints:

min: 1

max: 99

configurationBundle -> (structure) [required]

The configuration bundle reference for this variant.

bundleArn -> (string) [required]

The Amazon Resource Name (ARN) of the configuration bundle.

Constraints:

pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

bundleVersion -> (string) [required]

The version of the configuration bundle.

Constraints:

pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

description -> (string)

The description of this traffic split variant.

Constraints:

min: 1

max: 200

metadata -> (map)

Key-value metadata associated with this traffic split variant.

Constraints:

min: 0

max: 25

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 1

max: 256

routeToTarget -> (tagged union structure)

An action that routes the request to a specific target.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: staticRoute, weightedRoute.

staticRoute -> (structure)

A static route that sends all matching requests to a single target.

targetName -> (string) [required]

The name of the target to route requests to.

Constraints:

pattern: ([0-9a-zA-Z][-]?){1,100}

model -> (string)

The model ID to send to the target. Supported only for inference targets. If you don’t specify a model, the gateway sends the model from the original request.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9][a-zA-Z0-9\-._/@:]*

fallback -> (structure)

The fallback configuration for this route. Supported only for inference targets.

triggerOn -> (structure)

The status codes and errors from the route’s target that cause the gateway to send the request to the first fallback target. If you omit triggerOn , the gateway falls back on 5XX status codes and on the CONNECTION_ERROR , FIRST_BYTE_TIMEOUT , and UNROUTABLE errors. If you specify triggerOn , only the status codes and errors that you list trigger a fallback.

statusCodes -> (list)

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

An exact status code – A three-digit code, such as 429 .

A class of status codes – The first digit followed by XX , such as 5XX , which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn’t trigger a fallback.

Constraints:

min: 1

max: 10

(string)

Constraints:

pattern: [4-5]([0-9]{2}|XX)

errors -> (list)

The errors that trigger a fallback. You can specify the following:

CONNECTION_ERROR – The gateway couldn’t connect to the target because the connection was refused, reset, or timed out. The request didn’t reach the target.

FIRST_BYTE_TIMEOUT – The target accepted the connection but didn’t return the first byte of the response within firstByteTimeoutMilliseconds . The gateway abandons the request before any of the response reaches you.

UNROUTABLE – The gateway couldn’t route the request to the target, for example because the target doesn’t exist or doesn’t support the request path. These errors don’t count toward the circuit breaker.

Constraints:

min: 1

max: 3

(string)

Possible values:

CONNECTION_ERROR

FIRST_BYTE_TIMEOUT

UNROUTABLE

firstByteTimeoutMilliseconds -> (integer)

The maximum time, in milliseconds, from sending the request to the route’s target until the first byte of the response body arrives. If the time expires, the gateway abandons the request and treats it as a FIRST_BYTE_TIMEOUT error. If you don’t specify a value, no timeout is enforced.

Constraints:

min: 50

max: 900000

circuitBreaker -> (structure)

Specifies whether the gateway temporarily stops sending your requests to a failing target. The circuit breaker tracks each combination of target and model separately. With the circuit breaker enabled, the gateway skips one or more targets and models that fail repeatedly, and your requests go to the next target in the chain. The gateway always tries the last remaining target in the chain. The gateway enables the circuit breaker by default.

mode -> (string)

Specifies whether you want the circuit breaker turned on. To turn it off, set this value to DISABLED . The default is ENABLED .

Possible values:

ENABLED

DISABLED

targetFallback -> (list) [required]

The ordered list of fallback targets. The gateway tries each target in order until a response doesn’t match that target’s triggers, and returns that response to the caller. If every target fails, the gateway returns the last response. You can specify up to two fallback targets. Each combination of target and model, including the route’s target, can appear only once.

Constraints:

min: 1

max: 2

(structure)

Specifies a target to send the request to when the previous target in the fallback chain fails. Includes the target name, the model to send, and the conditions that trigger a fallback from this target to the next one.

targetName -> (string) [required]

The name of the gateway target to fall back to. The target must be an inference target.

Constraints:

pattern: ([0-9a-zA-Z][-]?){1,100}

model -> (string)

The model ID to send to this fallback target. If you don’t specify a model, the gateway sends the model from the original request.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9][a-zA-Z0-9\-._/@:]*

triggerOn -> (structure)

The status codes and errors from this target that cause the gateway to send the request to the next fallback target. This setting isn’t inherited from the route. If you omit it, the gateway uses the default triggers: 5XX status codes and the CONNECTION_ERROR , FIRST_BYTE_TIMEOUT , and UNROUTABLE errors.

statusCodes -> (list)

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

An exact status code – A three-digit code, such as 429 .

A class of status codes – The first digit followed by XX , such as 5XX , which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn’t trigger a fallback.

Constraints:

min: 1

max: 10

(string)

Constraints:

pattern: [4-5]([0-9]{2}|XX)

errors -> (list)

The errors that trigger a fallback. You can specify the following:

CONNECTION_ERROR – The gateway couldn’t connect to the target because the connection was refused, reset, or timed out. The request didn’t reach the target.

FIRST_BYTE_TIMEOUT – The target accepted the connection but didn’t return the first byte of the response within firstByteTimeoutMilliseconds . The gateway abandons the request before any of the response reaches you.

UNROUTABLE – The gateway couldn’t route the request to the target, for example because the target doesn’t exist or doesn’t support the request path. These errors don’t count toward the circuit breaker.

Constraints:

min: 1

max: 3

(string)

Possible values:

CONNECTION_ERROR

FIRST_BYTE_TIMEOUT

UNROUTABLE

firstByteTimeoutMilliseconds -> (integer)

The maximum time, in milliseconds, from sending the request to this target until the first byte of the response body arrives. This setting isn’t inherited from the route. If you don’t specify a value, no timeout is enforced.

Constraints:

min: 50

max: 900000

weightedRoute -> (structure)

A weighted route that splits traffic between multiple targets.

trafficSplit -> (list) [required]

The traffic split entries defining how traffic is distributed between targets.

Constraints:

min: 2

max: 2

(structure)

An entry in a target traffic split configuration.

targetName -> (string) [required]

The name of the target to route traffic to.

Constraints:

pattern: ([0-9a-zA-Z][-]?){1,100}

model -> (string)

The model ID to send to the target for this variant. Supported only for inference targets. If you don’t specify a model, the gateway sends the model from the original request.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9][a-zA-Z0-9\-._/@:]*

fallback -> (structure)

The fallback configuration for this variant. Supported only for inference targets.

triggerOn -> (structure)

The status codes and errors from the route’s target that cause the gateway to send the request to the first fallback target. If you omit triggerOn , the gateway falls back on 5XX status codes and on the CONNECTION_ERROR , FIRST_BYTE_TIMEOUT , and UNROUTABLE errors. If you specify triggerOn , only the status codes and errors that you list trigger a fallback.

statusCodes -> (list)

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

An exact status code – A three-digit code, such as 429 .

A class of status codes – The first digit followed by XX , such as 5XX , which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn’t trigger a fallback.

Constraints:

min: 1

max: 10

(string)

Constraints:

pattern: [4-5]([0-9]{2}|XX)

errors -> (list)

The errors that trigger a fallback. You can specify the following:

CONNECTION_ERROR – The gateway couldn’t connect to the target because the connection was refused, reset, or timed out. The request didn’t reach the target.

FIRST_BYTE_TIMEOUT – The target accepted the connection but didn’t return the first byte of the response within firstByteTimeoutMilliseconds . The gateway abandons the request before any of the response reaches you.

UNROUTABLE – The gateway couldn’t route the request to the target, for example because the target doesn’t exist or doesn’t support the request path. These errors don’t count toward the circuit breaker.

Constraints:

min: 1

max: 3

(string)

Possible values:

CONNECTION_ERROR

FIRST_BYTE_TIMEOUT

UNROUTABLE

firstByteTimeoutMilliseconds -> (integer)

The maximum time, in milliseconds, from sending the request to the route’s target until the first byte of the response body arrives. If the time expires, the gateway abandons the request and treats it as a FIRST_BYTE_TIMEOUT error. If you don’t specify a value, no timeout is enforced.

Constraints:

min: 50

max: 900000

circuitBreaker -> (structure)

Specifies whether the gateway temporarily stops sending your requests to a failing target. The circuit breaker tracks each combination of target and model separately. With the circuit breaker enabled, the gateway skips one or more targets and models that fail repeatedly, and your requests go to the next target in the chain. The gateway always tries the last remaining target in the chain. The gateway enables the circuit breaker by default.

mode -> (string)

Specifies whether you want the circuit breaker turned on. To turn it off, set this value to DISABLED . The default is ENABLED .

Possible values:

ENABLED

DISABLED

targetFallback -> (list) [required]

The ordered list of fallback targets. The gateway tries each target in order until a response doesn’t match that target’s triggers, and returns that response to the caller. If every target fails, the gateway returns the last response. You can specify up to two fallback targets. Each combination of target and model, including the route’s target, can appear only once.

Constraints:

min: 1

max: 2

(structure)

Specifies a target to send the request to when the previous target in the fallback chain fails. Includes the target name, the model to send, and the conditions that trigger a fallback from this target to the next one.

targetName -> (string) [required]

The name of the gateway target to fall back to. The target must be an inference target.

Constraints:

pattern: ([0-9a-zA-Z][-]?){1,100}

model -> (string)

The model ID to send to this fallback target. If you don’t specify a model, the gateway sends the model from the original request.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9][a-zA-Z0-9\-._/@:]*

triggerOn -> (structure)

The status codes and errors from this target that cause the gateway to send the request to the next fallback target. This setting isn’t inherited from the route. If you omit it, the gateway uses the default triggers: 5XX status codes and the CONNECTION_ERROR , FIRST_BYTE_TIMEOUT , and UNROUTABLE errors.

statusCodes -> (list)

The HTTP status codes returned by the target that trigger a fallback. You can specify the following:

An exact status code – A three-digit code, such as 429 .

A class of status codes – The first digit followed by XX , such as 5XX , which matches every code from 500 to 599.

Only 4XX and 5XX codes are supported. Throttling by the gateway itself doesn’t trigger a fallback.

Constraints:

min: 1

max: 10

(string)

Constraints:

pattern: [4-5]([0-9]{2}|XX)

errors -> (list)

The errors that trigger a fallback. You can specify the following:

CONNECTION_ERROR – The gateway couldn’t connect to the target because the connection was refused, reset, or timed out. The request didn’t reach the target.

FIRST_BYTE_TIMEOUT – The target accepted the connection but didn’t return the first byte of the response within firstByteTimeoutMilliseconds . The gateway abandons the request before any of the response reaches you.

UNROUTABLE – The gateway couldn’t route the request to the target, for example because the target doesn’t exist or doesn’t support the request path. These errors don’t count toward the circuit breaker.

Constraints:

min: 1

max: 3

(string)

Possible values:

CONNECTION_ERROR

FIRST_BYTE_TIMEOUT

UNROUTABLE

firstByteTimeoutMilliseconds -> (integer)

The maximum time, in milliseconds, from sending the request to this target until the first byte of the response body arrives. This setting isn’t inherited from the route. If you don’t specify a value, no timeout is enforced.

Constraints:

min: 50

max: 900000

name -> (string) [required]

The name of this traffic split variant.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?

weight -> (integer) [required]

The percentage of traffic to route to this variant.

Constraints:

min: 1

max: 99

description -> (string)

The description of this traffic split variant.

Constraints:

min: 1

max: 200

metadata -> (map)

Key-value metadata associated with this traffic split variant.

Constraints:

min: 0

max: 25

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 1

max: 256

description -> (string)

The description of the gateway rule.

Constraints:

min: 1

max: 256

createdAt -> (timestamp)

The timestamp when the rule was created.

status -> (string)

The current status of the rule.

Possible values:

CREATING

ACTIVE

UPDATING

DELETING

system -> (structure)

System-managed metadata for rules created by automated processes.

managedBy -> (string) [required]

The identifier of the system or process that manages this rule.

updatedAt -> (timestamp)

The timestamp when the rule was last updated.

Table of Contents

Feedback

User Guide

get-gateway-rule¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note

Note