Full Module Docs

kingpin.actors.aws.settings

Common settings used by many of the kingpin.actors.aws modules.

kingpin.actors.exceptions

All common Actor exceptions

exception kingpin.actors.exceptions.ActorException

Base Kingpin Actor Exception

exception kingpin.actors.exceptions.RecoverableActorFailure

Base exception that allows script executions to continue on failure.

This exception class is used to throw an error when an Actor fails, but it was an expected and/or acceptable failure.

This should be used for exceptions that are somewhat normal … for example, trying to delete a ServerArray thats already gone.

exception kingpin.actors.exceptions.UnrecoverableActorFailure

Base exception for unrecoverable failures.

This exception class should be used for critical failures that should always stop a set of Kingpin actors in-place, regardless of the actors warn_on_failure setting.

Examples would be when credentials are incorrect, or an unexpected exception is caught and there is no known recovery point.

exception kingpin.actors.exceptions.ActorTimedOut

Raised when an Actor takes too long to execute

exception kingpin.actors.exceptions.InvalidActor

Raised when an invalid Actor name was supplied

exception kingpin.actors.exceptions.InvalidOptions

Invalid option arguments passed into the Actor object.

This can be used both for the actual options dict passed into the actor, as well as if a the wrong options were used when connecting to a remote API.

exception kingpin.actors.exceptions.InvalidCredentials

Invalid or missing credentials required for Actor object.

exception kingpin.actors.exceptions.UnparseableResponseFromEndpoint

Invalid response returned from a remote REST endpoint.

exception kingpin.actors.exceptions.BadRequest

An action failed due to a HTTP 400 error likely due to bad input.

exception kingpin.exceptions.KingpinException

Base Exception

exception kingpin.exceptions.InvalidScript

Raised when an invalid script schema was detected

exception kingpin.exceptions.InvalidScriptName

Raised when the script name does not end on .yaml or .json

Kingpin version number. You must bump this when creating a new release.