CognitoIdentityProvider / Client / admin_list_user_auth_events
admin_list_user_auth_events#
- CognitoIdentityProvider.Client.admin_list_user_auth_events(**kwargs)#
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
See also: AWS API Documentation
Request Syntax
response = client.admin_list_user_auth_events( UserPoolId='string', Username='string', MaxResults=123, NextToken='string' )
- Parameters:
UserPoolId (string) –
[REQUIRED]
The user pool ID.
Username (string) –
[REQUIRED]
The user pool username or an alias.
MaxResults (integer) – The maximum number of authentication events to return. Returns 60 events if you set
MaxResults
to 0, or if you don’t include aMaxResults
parameter.NextToken (string) – A pagination token.
- Return type:
dict
- Returns:
Response Syntax
{ 'AuthEvents': [ { 'EventId': 'string', 'EventType': 'SignIn'|'SignUp'|'ForgotPassword'|'PasswordChange'|'ResendCode', 'CreationDate': datetime(2015, 1, 1), 'EventResponse': 'Pass'|'Fail'|'InProgress', 'EventRisk': { 'RiskDecision': 'NoRisk'|'AccountTakeover'|'Block', 'RiskLevel': 'Low'|'Medium'|'High', 'CompromisedCredentialsDetected': True|False }, 'ChallengeResponses': [ { 'ChallengeName': 'Password'|'Mfa', 'ChallengeResponse': 'Success'|'Failure' }, ], 'EventContextData': { 'IpAddress': 'string', 'DeviceName': 'string', 'Timezone': 'string', 'City': 'string', 'Country': 'string' }, 'EventFeedback': { 'FeedbackValue': 'Valid'|'Invalid', 'Provider': 'string', 'FeedbackDate': datetime(2015, 1, 1) } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
AuthEvents (list) –
The response object. It includes the
EventID
,EventType
,CreationDate
,EventRisk
, andEventResponse
.(dict) –
The authentication event type.
EventId (string) –
The event ID.
EventType (string) –
The event type.
CreationDate (datetime) –
The creation date
EventResponse (string) –
The event response.
EventRisk (dict) –
The event risk.
RiskDecision (string) –
The risk decision.
RiskLevel (string) –
The risk level.
CompromisedCredentialsDetected (boolean) –
Indicates whether compromised credentials were detected during an authentication event.
ChallengeResponses (list) –
The challenge responses.
(dict) –
The challenge response type.
ChallengeName (string) –
The challenge name.
ChallengeResponse (string) –
The challenge response.
EventContextData (dict) –
The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
IpAddress (string) –
The source IP address of your user’s device.
DeviceName (string) –
The user’s device name.
Timezone (string) –
The user’s time zone.
City (string) –
The user’s city.
Country (string) –
The user’s country.
EventFeedback (dict) –
A flag specifying the user feedback captured at the time of an event request is good or bad.
FeedbackValue (string) –
The event feedback value.
Provider (string) –
The provider.
FeedbackDate (datetime) –
The event feedback date.
NextToken (string) –
A pagination token.
Exceptions
CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.UserNotFoundException
CognitoIdentityProvider.Client.exceptions.UserPoolAddOnNotEnabledException
CognitoIdentityProvider.Client.exceptions.InternalErrorException