AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wickr ]

get-user

Description

Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

See also: AWS API Documentation

Synopsis

  get-user
--network-id <value>
--user-id <value>
[--start-time <value>]
[--end-time <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--network-id (string)

The ID of the Wickr network containing the user.

--user-id (string)

The unique identifier of the user to retrieve.

--start-time (timestamp)

The start time for filtering the user’s last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.

--end-time (timestamp)

The end time for filtering the user’s last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

userId -> (string)

The unique identifier of the user.

firstName -> (string)

The first name of the user.

lastName -> (string)

The last name of the user.

username -> (string)

The email address or username of the user.

isAdmin -> (boolean)

Indicates whether the user has administrator privileges in the network.

suspended -> (boolean)

Indicates whether the user is currently suspended.

status -> (integer)

The current status of the user (1 for pending, 2 for active).

lastActivity -> (integer)

The timestamp of the user’s last activity in the network, specified in epoch seconds.

lastLogin -> (integer)

The timestamp of the user’s last login to the network, specified in epoch seconds.

securityGroupIds -> (list)

A list of security group IDs to which the user belongs.

(string)