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

DescribeServiceErrors

Describes AWS OpsWorks Stacks service errors.

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

This call accepts only one resource-identifying parameter.

Request Syntax

{
   "InstanceId": "string",
   "ServiceErrorIds": [ "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.

InstanceId

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

Type: String

Required: No

ServiceErrorIds

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

Type: Array of strings

Required: No

StackId

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

Type: String

Required: No

Response Syntax

{
   "ServiceErrors": [ 
      { 
         "CreatedAt": "string",
         "InstanceId": "string",
         "Message": "string",
         "ServiceErrorId": "string",
         "StackId": "string",
         "Type": "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.

ServiceErrors

An array of ServiceError objects that describe the specified service errors.

Type: Array of ServiceError 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: