DescribePermissions
Describes the permissions for a specified stack.
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
{ "IamUserArn": "
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.
- IamUserArn
-
The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.
Type: String
Required: No
- StackId
-
The stack ID.
Type: String
Required: No
Response Syntax
{ "Permissions": [ { "AllowSsh": boolean, "AllowSudo": boolean, "IamUserArn": "string", "Level": "string", "StackId": "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.
- Permissions
-
An array of
Permission
objects that describe the stack permissions.-
If the request object contains only a stack ID, the array contains a
Permission
object with permissions for each of the stack IAM ARNs. -
If the request object contains only an IAM ARN, the array contains a
Permission
object with permissions for each of the user's stack IDs. -
If the request contains a stack ID and an IAM ARN, the array contains a single
Permission
object with permissions for the specified stack and IAM ARN.
Type: Array of Permission 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: