Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

AWS CLI v1 entered maintenance mode on August 5, 2026 and will reach end-of-support on July 15, 2027. During maintenance mode, releases are limited to critical bug fixes and security issues. AWS CLI v1 will not receive API updates for new or existing services, or be updated to support new regions. For more information, see the maintenance mode announcement.

We recommend that you migrate to AWS CLI version 2. See the installation instructions and migration guide.

[ aws . rtbfabric ]

list-links

Description

Lists links associated with gateways.

Returns a list of all links for the specified gateways, including their status and configuration details.

See also: AWS API Documentation

list-links is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: links

Synopsis

  list-links
--gateway-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
[--v2-debug]

Options

--gateway-id (string)

The unique identifier of the gateway.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

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

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

links -> (list)

Information about created links.

(structure)

Describes a link.

gatewayId -> (string)

The unique identifier of the gateway.

peerGatewayId -> (string)

The unique identifier of the peer gateway.

status -> (string)

The status of the link.

createdAt -> (timestamp)

The timestamp of when the link was created.

updatedAt -> (timestamp)

The timestamp of when the link was updated.

direction -> (string)

The direction of the link.

flowModules -> (list)

Describes the configuration of flow modules.

(structure)

Describes the configuration of a module.

version -> (string)

The version of the module.

name -> (string)

The name of the module.

dependsOn -> (list)

The dependencies of the module.

(string)

moduleParameters -> (tagged union structure)

Describes the parameters of a module.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: noBid, openRtbAttribute, rateLimiter.

noBid -> (structure)

Describes the parameters of a no bid module.

reason -> (string)

The reason description.

reasonCode -> (integer)

The reason code.

passThroughPercentage -> (float)

The pass through percentage.

openRtbAttribute -> (structure)

Describes the parameters of an open RTB attribute module.

filterType -> (string)

The filter type.

filterConfiguration -> (list)

Describes the configuration of a filter.

(structure)

Describes the configuration of a filter.

criteria -> (list)

Describes the criteria for a filter.

(structure)

Describes the criteria for a filter.

path -> (string)

The path to filter.

values -> (list)

The value to filter.

(string)

action -> (tagged union structure)

Describes a bid action.

Note

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

noBid -> (structure)

Describes a no bid action.

noBidReasonCode -> (integer)

The reason code for the no bid action.

headerTag -> (structure)

Describes the header tag for a bid action.

name -> (string)

The name of the bid action.

value -> (string)

The value of the bid action.

holdbackPercentage -> (float)

The hold back percentage.

rateLimiter -> (structure)

Describes the parameters of a rate limit.

tps -> (float)

The transactions per second rate limit.

pendingFlowModules -> (list)

Describes the configuration of pending flow modules.

(structure)

Describes the configuration of a module.

version -> (string)

The version of the module.

name -> (string)

The name of the module.

dependsOn -> (list)

The dependencies of the module.

(string)

moduleParameters -> (tagged union structure)

Describes the parameters of a module.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: noBid, openRtbAttribute, rateLimiter.

noBid -> (structure)

Describes the parameters of a no bid module.

reason -> (string)

The reason description.

reasonCode -> (integer)

The reason code.

passThroughPercentage -> (float)

The pass through percentage.

openRtbAttribute -> (structure)

Describes the parameters of an open RTB attribute module.

filterType -> (string)

The filter type.

filterConfiguration -> (list)

Describes the configuration of a filter.

(structure)

Describes the configuration of a filter.

criteria -> (list)

Describes the criteria for a filter.

(structure)

Describes the criteria for a filter.

path -> (string)

The path to filter.

values -> (list)

The value to filter.

(string)

action -> (tagged union structure)

Describes a bid action.

Note

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

noBid -> (structure)

Describes a no bid action.

noBidReasonCode -> (integer)

The reason code for the no bid action.

headerTag -> (structure)

Describes the header tag for a bid action.

name -> (string)

The name of the bid action.

value -> (string)

The value of the bid action.

holdbackPercentage -> (float)

The hold back percentage.

rateLimiter -> (structure)

Describes the parameters of a rate limit.

tps -> (float)

The transactions per second rate limit.

attributes -> (structure)

Describes attributes of a link.

responderErrorMasking -> (list)

Describes the masking for HTTP error codes.

(structure)

Describes the masking for HTTP error codes.

httpCode -> (string)

The HTTP error code.

action -> (string)

The action for the error..

loggingTypes -> (list)

The error log type.

(string)

responseLoggingPercentage -> (float)

The percentage of response logging.

customerProvidedId -> (string)

The customer-provided unique identifier of the link.

logSettings -> (structure)

Describes the settings for a link log.

applicationLogs -> (structure)

Describes the configuration of a link application log.

sampling -> (structure)

Describes a link application log sample.

errorLog -> (double)

An error log entry.

filterLog -> (double)

A filter log entry.

connectivityType -> (string)

The connectivity type of the link.

linkId -> (string)

The unique identifier of the link.

tags -> (map)

A map of the key-value pairs of the tag or tags to assign to the resource.

key -> (string)

value -> (string)

publicEndpoint -> (string)

The public endpoint of the outbound link.

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 .