list-link-routing-rules¶

Description¶

Lists the routing rules for a link.

Synopsis¶

  list-link-routing-rules
--gateway-id <value>
--link-id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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-id (string) [required]

The unique identifier of the gateway.

Constraints:

min: 8

max: 32

pattern: rtb-gw-[a-z0-9-]{1,25}

--link-id (string) [required]

The unique identifier of the link.

Constraints:

min: 6

max: 30

pattern: link-[a-z0-9-]{1,25}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 10

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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¶

rules -> (list)

The list of routing rules for the link.

(structure)

A summary of a link routing rule.

ruleId -> (string) [required]

The unique identifier of the routing rule.

Constraints:

min: 6

max: 30

pattern: rule-[a-z0-9-]{1,25}

priority -> (integer) [required]

The priority of the routing rule.

Constraints:

min: 1

max: 1000

conditions -> (structure) [required]

The conditions for the routing rule.

hostHeader -> (string)

The exact host header value to match.

Constraints:

min: 1

max: 255

pattern: [A-Za-z0-9._~-]+

hostHeaderWildcard -> (string)

A wildcard pattern for host header matching (for example, *.example.com ).

Constraints:

min: 3

max: 255

pattern: [A-Za-z0-9._~*-]+

pathPrefix -> (string)

The path prefix to match. The request path must start with this value. Must start with / .

Constraints:

min: 1

max: 128

pattern: /[A-Za-z0-9._~/-]*

pathExact -> (string)

The exact path to match. Must start with / .

Constraints:

min: 1

max: 128

pattern: /[A-Za-z0-9._~/-]*

queryStringEquals -> (structure)

A query string key-value pair that must be present and match exactly.

key -> (string) [required]

The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.

Constraints:

min: 1

max: 128

pattern: [A-Za-z0-9._~-]+

value -> (string) [required]

The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.

Constraints:

min: 1

max: 128

pattern: [A-Za-z0-9._~-]+

queryStringExists -> (string)

A query string key that must be present in the request (any value is accepted).

Constraints:

min: 1

max: 128

pattern: [A-Za-z0-9._~-]+

status -> (string) [required]

The status of the routing rule.

Possible values:

CREATION_IN_PROGRESS

ACTIVE

UPDATE_IN_PROGRESS

DELETION_IN_PROGRESS

DELETED

FAILED

createdAt -> (timestamp) [required]

The timestamp of when the routing rule was created.

updatedAt -> (timestamp) [required]

The timestamp of when the routing rule was last updated.

nextToken -> (string)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error .

Table of Contents

Feedback

User Guide