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



Describe specified users.

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--iam-user-arns <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--iam-user-arns (list)

An array of IAM or federated user ARNs that identify the users to be described.



"string" "string" ...

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

See 'aws help' for descriptions of global parameters.


To describe user profiles

The following describe-user-profiles command describes the account's user profiles.

aws opsworks --region us-east-1 describe-user-profiles


  "UserProfiles": [
      "IamUserArn": "arn:aws:iam::123456789012:user/someuser",
      "SshPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAkOuP7i80q3Cko...",
      "AllowSelfManagement": true,
      "Name": "someuser",
      "SshUsername": "someuser"
      "IamUserArn": "arn:aws:iam::123456789012:user/cli-user-test",
      "AllowSelfManagement": true,
      "Name": "cli-user-test",
      "SshUsername": "myusername"

More Information

For more information, see Managing AWS OpsWorks Users in the AWS OpsWorks User Guide.


UserProfiles -> (list)

A Users object that describes the specified users.


Describes a user's SSH information.

IamUserArn -> (string)

The user's IAM ARN.

Name -> (string)

The user's name.

SshUsername -> (string)

The user's SSH user name.

SshPublicKey -> (string)

The user's SSH public key.

AllowSelfManagement -> (boolean)

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions .