SessionDescriptionType

Describes an active user session. Amazon Cognito returns this type in the responses of ListUserSessions and AdminListUserSessions, for both token sessions and SSO sessions.

ClientId

The ID of the app client that the session belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+]+

Required: No

CreateDate

The date and time when the session was created.

Type: Timestamp

Required: No

DeviceType

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

IsCurrentSession

Specifies whether this session matches the access token supplied in the request. This value is always false for the AdminListUserSessions operation, which doesn't take an access token.

Type: Boolean

Required: No

LastActiveDate

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.

Type: Timestamp

Required: No

LastIPAddress

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

LastLocation

The geographic location of the most recent activity on the session, derived from the IP address.

Type: SessionLocationType object

Required: No

OriginSessionId

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.

Type: String

Length Constraints: Fixed length of 28.

Pattern: ^(tkn|sso)[a-z0-9]{25}$

Required: No

SessionId

The unique identifier for the session. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.

Type: String

Length Constraints: Fixed length of 28.

Pattern: ^(tkn|sso)[a-z0-9]{25}$

Required: No

SessionType

The type of the session. Valid values are TOKEN and SSO.

Type: String

Valid Values: TOKEN | SSO

Required: No

SessionDescriptionType

Contents

See Also