[ aws . opsworks ]

describe-my-user-profile

Description

Describes a user’s SSH information.

Required Permissions : To use this action, an IAM user must have self-management enabled or 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.

Synopsis

  describe-my-user-profile
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To obtain a user’s profile

The following example shows how to obtain the profile of the AWS Identity and Access Management (IAM) user that is running the command.

aws opsworks --region us-east-1 describe-my-user-profile

Output: For brevity, most of the user’s SSH public key is replaced by an ellipsis (…).

{
  "UserProfile": {
    "IamUserArn": "arn:aws:iam::123456789012:user/myusername",
    "SshPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQ...3LQ4aX9jpxQw== rsa-key-20141104",
    "Name": "myusername",
    "SshUsername": "myusername"
  }
}

More Information

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

Output

UserProfile -> (structure)

A UserProfile object that describes the 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.