[ aws . cognito-idp ]
Lists the active sessions for a specified user as an administrator. The response includes both token sessions and SSO sessions. Only active sessions are returned; revoked and expired sessions aren’t included. Amazon Cognito returns all of a user’s sessions in a single page of up to 125 sessions. The results are eventually consistent, and new sessions are typically included within a few seconds.
See also: AWS API Documentation
admin-list-user-sessions
--user-pool-id <value>
--username <value>
[--next-token <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]
--user-pool-id (string) [required]
The ID of the user pool that contains the user.
Constraints:
- min:
1- max:
55- pattern:
[\w-]+_[0-9a-zA-Z]+
--username (string) [required]
The username of the user whose sessions you want to list.
Constraints:
- min:
1- max:
128- pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
--next-token (string)
A pagination token that Amazon Cognito returned in a previous response. Use this value to retrieve the next page of results if a
NextTokenwas included in a prior response.Constraints:
- min:
1- max:
131072- pattern:
[\S]+
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
Sessions -> (list)
A list of the user’s active sessions. Each element describes one token session or SSO session.
Constraints:
- min:
0- max:
125(structure)
Describes an active user session. Amazon Cognito returns this type in the responses of
ListUserSessionsandAdminListUserSessions, for both token sessions and SSO sessions.SessionId -> (string)
The unique identifier for the session. This is a 28-character string of lowercase letters and digits, prefixed with
tknfor a token session orssofor an SSO session.Constraints:
- min:
28- max:
28- pattern:
^(tkn|sso)[a-z0-9]{25}$SessionType -> (string)
The type of the session. Valid values are
TOKENandSSO.Possible values:
TOKENSSOClientId -> (string)
The ID of the app client that the session belongs to.
Constraints:
- min:
1- max:
128- pattern:
[\w+]+CreateDate -> (timestamp)
The date and time when the session was created.LastActiveDate -> (timestamp)
The date and time of the most recent activity on the session. For a token session, this is the most recent token refresh or rotation; a new authentication creates a new token session rather than updating an existing one. For an SSO session, this is the most recent authentication, token grant, or token rotation.DeviceType -> (string)
A description of the device associated with the most recent activity on the session, derived from the parsed user agent (operating system and browser or app). Amazon Cognito overwrites this value on each sign-in, refresh, and rotation. The value can be
unknown. The maximum length is 1,024 characters.Constraints:
- min:
0- max:
1024LastIPAddress -> (string)
The IP address associated with the most recent activity on the session. Amazon Cognito overwrites this value on each refresh and rotation. The maximum length is 128 characters.
Constraints:
- min:
0- max:
128LastLocation -> (structure)
The geographic location of the most recent activity on the session, derived from the IP address.
City -> (string)
The city of the most recent activity on the session, derived from the IP address. This value can be null if geo-IP resolution fails. The maximum length is 256 characters.
Constraints:
- min:
0- max:
256Country -> (string)
The country of the most recent activity on the session, derived from the IP address and returned in English (for example,
United States). This is a country name as returned by the geo-IP database, not an ISO country code, and can beunknownif geo-IP resolution fails.Constraints:
- min:
0- max:
256OriginSessionId -> (string)
For a token session, the ID of the SSO session that the token session originated from. This value is null for sessions that were initiated through the API and didn’t come through an SSO session. Amazon Cognito returns this value for token sessions only.
Constraints:
- min:
28- max:
28- pattern:
^(tkn|sso)[a-z0-9]{25}$IsCurrentSession -> (boolean)
Specifies whether this session matches the access token supplied in the request. This value is alwaysfalsefor theAdminListUserSessionsoperation, which doesn’t take an access token.
NextToken -> (string)
The pagination token to use in a subsequent request to retrieve the next page of results.
Constraints:
- min:
1- max:
131072- pattern:
[\S]+