py_swf.clients.admin

class py_swf.clients.admin.WorkflowRegistrar(boto_client)[source]

A client that allows creation of SWF environments. Allows you to create domains, task lists, workflow types, and activity types.

Parameters:boto_client (Client) – A raw SWF boto3 client.
register_activity_type(*args, **kwargs)[source]

Creates an activity type

Passthrough to register_activity_type().

Parameters:
  • domain (string) – Registers the activity type to this domain.
  • name (string) – Name of the activity type to register.
  • version (string) – Freeform text that represents the version of the activity type.
  • task_heartbeat_timeout (double) – Represents a timeout for subsequent heartbeats sent by an activity task. Measured in seconds.
  • task_list_name (string) – Registers the activity type to this task list name.
  • task_priority (int) – Represents a priority for this task to run. Valid within the range of (-2147483648, 2147483647). Higher numbers indicate higher priority.
  • task_schedule_to_close_timeout (double) – The timeout for activities when scheduled until response. Measured in seconds.
  • task_schedule_to_start_timeout (double) – The timeout for activities when submitted until they are scheduled. Measured in seconds.
  • task_start_to_close_timeout (double) – End-to-end timeout for when activities are submitted until response. Measured in seconds.
  • description (string) – Describes what the activity task does
Returns:

None
Return type:

NoneType
register_domain(*args, **kwargs)[source]

Creates an swf domain.

Passthrough to register_domain().

Parameters:
  • name (string) – Name of the domain
  • description (string) – An optional description of the domain.
  • retention (int) – An optional retention of the domain. Measured in days. If None is passed in, the retention is 0. Defaults to 90 days.
Returns:

None
Return type:

NoneType
register_workflow_type(*args, **kwargs)[source]

Creates a workflow type

Passthrough to register_workflow_type().

Parameters:
  • domain (string) – Registers the workflow type to this domain.
  • name (string) – Name of the workflow type to register.
  • version (string) – Freeform text that represents the version of the workflow type.
  • child_policy (string of ('TERMINATE'|'REQUEST_CANCEL'|'ABANDON')) – Determins the child workflow policy upon termination.
  • execution_start_to_close_timeout (double) – Represents the end-to-end timeout for a workflow. Measured in seconds.
  • lambda_role (string) – The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
  • task_list_name (string) – Registers this workflow type to this task list.
  • task_priority (int) – Sets the task priority for this workflow type. Valid values are in the range of (-2147483648, 2147483647). Higher numbers indicate higher priority.
  • task_start_to_close_timeout (double) – Represents end-to-end activity task timeouts. Measured in seconds.
  • description (string) – Describes what the workflow type does.
Returns:

None
Return type:

NoneType