Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

UpdateUserProfile

Updates a specified user profile.

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

Request Syntax

{
   "AllowSelfManagement": boolean,
   "IamUserArn": "string",
   "SshPublicKey": "string",
   "SshUsername": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AllowSelfManagement

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

Type: Boolean

Required: No

IamUserArn

The user IAM ARN. This can also be a federated user's ARN.

Type: String

Required: Yes

SshPublicKey

The user's new SSH public key.

Type: String

Required: No

SshUsername

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

Type: String

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: