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 . finspace-data ]
Lists all available users in FinSpace.
See also: AWS API Documentation
list-users
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: users
list-users
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
--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.
--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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--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.
users -> (list)
A list of all the users.
(structure)
The details of the user.
userId -> (string)
The unique identifier for the user.status -> (string)
The current status of the user.
CREATING
– The user creation is in progress.ENABLED
– The user is created and is currently active.DISABLED
– The user is currently inactive.firstName -> (string)
The first name of the user.lastName -> (string)
The last name of the user.emailAddress -> (string)
The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.type -> (string)
Indicates the type of user.
SUPER_USER
– A user with permission to all the functionality and data in FinSpace.APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.apiAccess -> (string)
Indicates whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.
ENABLED
– The user has permissions to use the APIs.DISABLED
– The user does not have permissions to use any APIs.apiAccessPrincipalArn -> (string)
The ARN identifier of an AWS user or role that is allowed to call theGetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.createTime -> (long)
The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.lastEnabledTime -> (long)
Describes the last time the user was activated. The value is determined as epoch time in milliseconds.lastDisabledTime -> (long)
Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.lastModifiedTime -> (long)
Describes the last time the user was updated. The value is determined as epoch time in milliseconds.lastLoginTime -> (long)
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
nextToken -> (string)
A token that indicates where a results page should begin.