show_supported_devices | API References | Fire Opal | References

fireopal.show_supported_devices(credentials)

Retrieve the list of hardware devices currently supported by Fire Opal.

Use this function to discover valid backend names before calling other Fire Opal functions such as execute or validate. The available devices depend on the provider specified in credentials and the access associated with those credentials.

Parameters

credentials (Credentials) – The hardware provider credentials. See the credentials module for functions to generate credentials for your desired provider.

Returns

dict – A dictionary with the following keys:

supported_devices : Names of the backends currently supported by Fire Opal for the given provider.
warnings : Any advisory messages returned by the workflow. Empty when there are no warnings.

Raises

ValueError – If the show_supported_devices workflow is not supported by the provider specified in credentials.