[ aws . cognito-idp ]

admin-list-user-auth-events

Description

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

admin-list-user-auth-events is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AuthEvents

Synopsis

  admin-list-user-auth-events
--user-pool-id <value>
--username <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--username (string)

The user pool username or an alias.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Examples

To list authorization events for a user

This example lists authorization events for username diego@example.com.

Command:

aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

Output

AuthEvents -> (list)

The response object. It includes the EventID , EventType , CreationDate , EventRisk , and EventResponse .

(structure)

The authentication event type.

EventId -> (string)

The event ID.

EventType -> (string)

The event type.

CreationDate -> (timestamp)

The creation date

EventResponse -> (string)

The event response.

EventRisk -> (structure)

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.

(structure)

The challenge response type.

ChallengeName -> (string)

The challenge name.

ChallengeResponse -> (string)

The challenge response.

EventContextData -> (structure)

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 -> (structure)

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 -> (timestamp)

The event feedback date.

NextToken -> (string)

A pagination token.