<a id="cli-aws-rtbfabric-put-link-flows"></a>

# put-link-flows

## Description

Replaces a link’s flow configuration. The change applies asynchronously. The call returns once the change is accepted, and the link serves its prior flows until the update commits atomically. RTB Fabric validates the request before accepting it, and a request that fails validation changes nothing. After the call, use GetLink. Once the change completes, the link’s status is ACTIVE again and its flows show the change.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rtbfabric-2023-05-15/PutLinkFlows)

## Synopsis

```
  put-link-flows
--gateway-id <value>
--link-id <value>
[--client-token <value>]
--lock-token <value>
--flows <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>]
[--help]
```

## 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}`

`--client-token` (string)

> A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry with the same token and parameters, you get the original response without an error. If you retry with the same token but different parameters, the call fails with ValidationException. If you don’t provide a token, the SDK generates one, and RTB Fabric remembers it for 8 hours. A retry returns the original `updateId` before `lockToken` is checked.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `[!-~]+`

`--lock-token` (string) [required]

> The concurrency token that you read from GetLink. If the link changed since that read, by any operation, the call fails with ConflictException.

> Constraints:

> * min: `1`
> * max: `256`

`--flows` (list) [required]

> The link’s flows, replacing the current ones. An empty list removes every flow.

> Constraints:

> * min: `0`
> * max: `1`

> (structure)

> > One flow on a link: a set of modules that runs on the link’s bid requests.

> > name -> (string) [required]

> > > The flow’s name, unique within the link.

> > > Constraints:

> > > * min: `1`
> > > * max: `64`
> > > * pattern: `[A-Za-z0-9][A-Za-z0-9-]*`

> > pipeline -> (tagged union structure) [required]

> > > The pipeline that the flow’s modules run in. In a sequential pipeline, each module sees the previous module’s output. In a phased pipeline, a phase’s modules see the prior phase’s output, not each other’s.

> > > #### NOTE
> > > This is a Tagged Union structure. Only one of the following top level keys can be set: `sequential`, `phased`.

> > > sequential -> (structure)

> > > > Modules run in list order. Use it when each module needs the previous module’s output.

> > > > modules -> (list) [required]

> > > > > In execution order.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `8`

> > > > > (structure)

> > > > > > A version attached to a flow, with its settings.

> > > > > > name -> (string) [required]

> > > > > > > The module’s name, unique within the flow.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `64`
> > > > > > > * pattern: `[A-Za-z0-9][A-Za-z0-9-]*`

> > > > > > moduleVersionArn -> (string) [required]

> > > > > > > The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that’s already in the link’s flows after it’s deprecated, but you can’t give it a higher share of traffic.

> > > > > > > Constraints:

> > > > > > > * min: `0`
> > > > > > > * max: `1011`
> > > > > > > * pattern: `arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}/versions/(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})`

> > > > > > selectedActions -> (list)

> > > > > > > The capabilities to turn on, chosen from the version’s `configurableActions` . If the version exposes one, it’s the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `16`

> > > > > > > (string)

> > > > > > > > A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.

> > > > > > > > Possible values:

> > > > > > > > * `FILTER`
> > > > > > > > * `ENRICH_REQUEST_EXT`
> > > > > > > > * `ENRICH_REQUEST_HEADERS`
> > > > > > > > * `OBSERVE`

> > > > > > failureMode -> (string)

> > > > > > > Specifies what happens when the module fails – when its call fails or times out, or when an express module’s dataset is stale. The default is OPEN.

> > > > > > > Possible values:

> > > > > > > * `OPEN`
> > > > > > > * `CLOSED`

> > > > > > activationPercentage -> (float)

> > > > > > > The percentage of the flow’s requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.

> > > > > > > Constraints:

> > > > > > > * min: `0`
> > > > > > > * max: `100`

> > > > > > configurationValues -> (string)

> > > > > > > RTB Fabric validates the value against the version’s `configurationSchema` and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `10240`

> > > phased -> (structure)

> > > > Phases run in order; a phase’s modules run concurrently on the same input. Use it when a phase’s modules don’t depend on each other.

> > > > phases -> (list) [required]

> > > > > At most 8 modules in total across the phases; more fails with ValidationException.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `8`

> > > > > (structure)

> > > > > > One phase of a phased pipeline. Its modules run concurrently on the previous phase’s output.

> > > > > > modules -> (list) [required]

> > > > > > > At most one MUTATE_REQUEST_BODY module.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `8`

> > > > > > > (structure)

> > > > > > > > A version attached to a flow, with its settings.

> > > > > > > > name -> (string) [required]

> > > > > > > > > The module’s name, unique within the flow.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `1`
> > > > > > > > > * max: `64`
> > > > > > > > > * pattern: `[A-Za-z0-9][A-Za-z0-9-]*`

> > > > > > > > moduleVersionArn -> (string) [required]

> > > > > > > > > The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that’s already in the link’s flows after it’s deprecated, but you can’t give it a higher share of traffic.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `0`
> > > > > > > > > * max: `1011`
> > > > > > > > > * pattern: `arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}/versions/(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})`

> > > > > > > > selectedActions -> (list)

> > > > > > > > > The capabilities to turn on, chosen from the version’s `configurableActions` . If the version exposes one, it’s the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `1`
> > > > > > > > > * max: `16`

> > > > > > > > > (string)

> > > > > > > > > > A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.

> > > > > > > > > > Possible values:

> > > > > > > > > > * `FILTER`
> > > > > > > > > > * `ENRICH_REQUEST_EXT`
> > > > > > > > > > * `ENRICH_REQUEST_HEADERS`
> > > > > > > > > > * `OBSERVE`

> > > > > > > > failureMode -> (string)

> > > > > > > > > Specifies what happens when the module fails – when its call fails or times out, or when an express module’s dataset is stale. The default is OPEN.

> > > > > > > > > Possible values:

> > > > > > > > > * `OPEN`
> > > > > > > > > * `CLOSED`

> > > > > > > > activationPercentage -> (float)

> > > > > > > > > The percentage of the flow’s requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `0`
> > > > > > > > > * max: `100`

> > > > > > > > configurationValues -> (string)

> > > > > > > > > RTB Fabric validates the value against the version’s `configurationSchema` and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `1`
> > > > > > > > > * max: `10240`

JSON Syntax:

```json
[
  {
    "name": "string",
    "pipeline": {
      "sequential": {
        "modules": [
          {
            "name": "string",
            "moduleVersionArn": "string",
            "selectedActions": ["FILTER"|"ENRICH_REQUEST_EXT"|"ENRICH_REQUEST_HEADERS"|"OBSERVE", ...],
            "failureMode": "OPEN"|"CLOSED",
            "activationPercentage": float,
            "configurationValues": "string"
          }
          ...
        ]
      },
      "phased": {
        "phases": [
          {
            "modules": [
              {
                "name": "string",
                "moduleVersionArn": "string",
                "selectedActions": ["FILTER"|"ENRICH_REQUEST_EXT"|"ENRICH_REQUEST_HEADERS"|"OBSERVE", ...],
                "failureMode": "OPEN"|"CLOSED",
                "activationPercentage": float,
                "configurationValues": "string"
              }
              ...
            ]
          }
          ...
        ]
      }
    }
  }
  ...
]
```

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

`--help` (boolean)

Display help for the command/subcommand.

## Output

gatewayId -> (string)

> The unique identifier of the gateway.

> Constraints:

> * min: `8`
> * max: `32`
> * pattern: `rtb-gw-[a-z0-9-]{1,25}`

linkId -> (string)

> The unique identifier of the link.

> Constraints:

> * min: `6`
> * max: `30`
> * pattern: `link-[a-z0-9-]{1,25}`

status -> (string)

> The link’s status. A successful call returns PENDING_UPDATE, and the link serves its prior flows until the change completes.

> Possible values:

> * `PENDING_CREATION`
> * `PENDING_REQUEST`
> * `REQUESTED`
> * `ACCEPTED`
> * `ACTIVE`
> * `REJECTED`
> * `FAILED`
> * `PENDING_DELETION`
> * `DELETED`
> * `PENDING_UPDATE`
> * `PENDING_ISOLATION`
> * `ISOLATED`
> * `PENDING_RESTORATION`
> * `CREATE_FAILED`
> * `DELETE_FAILED`

updateId -> (string)

> The ID of the update this call started.

> Constraints:

> * min: `8`
> * max: `64`
> * pattern: `update-[a-z0-9]{1,57}`
