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

DescribeUserProfiles

Describe specified users.

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

{
   "IamUserArns": [ "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.

IamUserArns

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

Type: Array of strings

Required: No

Response Syntax

{
   "UserProfiles": [ 
      { 
         "AllowSelfManagement": boolean,
         "IamUserArn": "string",
         "Name": "string",
         "SshPublicKey": "string",
         "SshUsername": "string"
      }
   ]
}

Response Elements

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

The following data is returned in JSON format by the service.

UserProfiles

A Users object that describes the specified users.

Type: Array of UserProfile objects

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: