Error Object

Description

When errors occur, the Skeddly API will return a model with the following properties:

Properties

errorCode

Error code related to the error.

Type: string

message

Descriptive message explaining (as best as possible) the error.

Type: string

modelState

Map of model errors.

Type: object

Sample JSON for Unauthorized Operation

{
    "errorCode": "UnauthorizedOperation",
    "message": "You are not authorized to execute actions:ListActions"
}

Sample JSON for Invalid Parameter

{
    "errorCode": "ParameterValidationFailed",
    "message": "Parameter validation failed",
    "modelState": {
        "parameters.InstanceIdentificationMethod": {
            "errors": [
                {
                    "errorMessage": "Invalid value for InstanceIdentificationMethod. Valid values are 'by-instance-id' or 'by-instance-name-tag'."
                }
            ]
        }
    }
}

Last updated