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

SetPermission

Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Request Syntax

{
   "AllowSsh": boolean,
   "AllowSudo": boolean,
   "IamUserArn": "string",
   "Level": "string",
   "StackId": "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.

AllowSsh

The user is allowed to use SSH to communicate with the instance.

Type: Boolean

Required: No

AllowSudo

The user is allowed to use sudo to elevate privileges.

Type: Boolean

Required: No

IamUserArn

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

Type: String

Required: Yes

Level

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions.

Type: String

Required: No

StackId

The stack ID.

Type: String

Required: Yes

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: