<a id="cli-aws-cognito-idp-set-user-pool-session-configuration"></a>

# set-user-pool-session-configuration

## Description

Enables or disables session tracking for a user pool, and sets the pool-wide maximum number of active token sessions that each user can have. This operation performs a full replacement of the pool-level session configuration; every request parameter is required. The user pool must be in the Essentials or Plus tier. Otherwise, this operation returns a `FeatureUnavailableInTierException` .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolSessionConfiguration)

## Synopsis

```
  set-user-pool-session-configuration
--user-pool-id <value>
--user-session-tracking <value>
--token-session <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

`--user-pool-id` (string) [required]

> The ID of the user pool where you want to configure session tracking.

> Constraints:

> * min: `1`
> * max: `55`
> * pattern: `[\w-]+_[0-9a-zA-Z]+`

`--user-session-tracking` (string) [required]

> Specifies whether Amazon Cognito tracks sessions for users in the user pool. Set this value to `ENABLED` to turn on server-side session tracking, or `DISABLED` to turn it off. When you set this value to `DISABLED` while the user pool remains active, existing client-level session configurations are retained but dormant, and are reactivated when you enable tracking again.

> Possible values:

> * `ENABLED`
> * `DISABLED`

`--token-session` (structure) [required]

> The pool-wide token session settings to apply.

> MaxPerUser -> (integer) [required]

> > The maximum number of active token sessions that a user can have across the user pool. The minimum value is `1` and the maximum value is `100` . The default is `20` . When a user reaches this limit, the next successful authentication automatically evicts that user’s least recently used token session before it creates the new session. Lowering this value doesn’t evict existing sessions on its own; the user is brought back within the limit on their next sign-in.

> > Constraints:

> > * min: `1`
> > * max: `100`

Shorthand Syntax:

```
MaxPerUser=integer
```

JSON Syntax:

```json
{
  "MaxPerUser": integer
}
```

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

UserPoolId -> (string)

> The ID of the user pool that the session configuration was applied to.

> Constraints:

> * min: `1`
> * max: `55`
> * pattern: `[\w-]+_[0-9a-zA-Z]+`

UserSessionTracking -> (string)

> The session tracking setting that was applied to the user pool.

> Possible values:

> * `ENABLED`
> * `DISABLED`

TokenSession -> (structure)

> The pool-wide token session settings that were applied.

> MaxPerUser -> (integer) [required]

> > The maximum number of active token sessions that a user can have across the user pool. The minimum value is `1` and the maximum value is `100` . The default is `20` . When a user reaches this limit, the next successful authentication automatically evicts that user’s least recently used token session before it creates the new session. Lowering this value doesn’t evict existing sessions on its own; the user is brought back within the limit on their next sign-in.

> > Constraints:

> > * min: `1`
> > * max: `100`