API Reference

Plugins

• Built-in plugins
• Optional plugins

Modules

• probator.config
• probator.constants
• probator.exceptions
• probator.json_utils
• probator.log
• probator.schema
• probator.utils
• probator.wrappers

Module contents

probator.get_local_aws_session()

Returns a session for the local instance, not for a remote account

Returns:boto3.session.Session

probator.get_aws_session(account)

Function to return a boto3 Session based on the account passed in the first argument.

Parameters:account (Account) – Account to create the session object for Returns:boto3.session.Session

probator.get_aws_regions(*, force=False)

Load a list of AWS regions from the AWS static data.

Parameters:force (bool) – Force fetch list of regions even if we already have a cached version Returns:list of str

probator.get_plugin_by_name(ns, name)

Load a plugin by namespace.name

Parameters:

• ns (str) – Plugin namespace
• name (str) – Plugin name

Returns:

class,`None` - Return the class object for the requested plugin, if found

probator.load_plugins()

Load available plugins

Returns:dict