Python API: sam v8_1_5
sam.listDefinitions()

Just having some fun...
This is the python interface to the command 'sam list definitions'.
Command Description:

List all matching dataset definitions.


Python Usage:
	from Sam import sam
	result = sam.listDefinitions(...)

Return value: SamStruct.DefinitionDetailsList.DefinitionDetailsList

Arguments are passed as keyword-value pairs, as in:
	 myfunc(arg1='myarg', arg2='anotherarg', d=1)

Argument Keyword Description:
	(*) indicates that this keyword is required
	>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
    KEYWORD                    DATA TYPE            DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
    after                      SamTime              limit the search to definitions created after this date
    before                     SamTime              limit the search to definitions created before this date
    c                          SamBoolean           automatically close all servants after each method call
    corbaCallTimeout           int                  time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
    d                          SamBoolean           debug mode
    definitionName             string               dataset definition name
    group                      string               group for whom the dataset was created
    keywords                   SamStringList        keywords associated with the definition
    retryInterval              int                  retry interval base in seconds; will multiply this base times retryCount (default: 5)
    retryJitter                int                  retry jitter, random jitter added to base retry interval times retryCount (default: 5)
    retryMaxCount              int                  number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
    t                          SamBoolean           time-it mode (print additional info on timings)
    userName                   string               user who created the definition
    v                          SamBoolean           verbose mode
====================================================================================================================================

Must have at least one of:	
	(definitionName, userName, group, keywords, before, after) 

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
	retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
	retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
	s = os.environ['SAM_PYAPI_RETRY_SILENTLY']



See Also: