Activities

SWF activity type management.

ActivityDetails	Activity type details and default activity task configuration.
ActivityId	Activity type identifier.
ActivityIdFilter	Activity type filter on activity name.
ActivityInfo	Activity type details.
DefaultTaskConfiguration	Default activity task configuration.
delete_activity	Delete a (deprecated/inactive) activity type.
deprecate_activity	Deprecate (deactivate) an activity type.
describe_activity	Describe an activity type.
list_activities	List activity types; retrieved semi-lazily.
register_activity	Register a new activity type.
undeprecate_activity	Undeprecate (reactivate) an activity type.

class swf_typed.ActivityDetails(info: ActivityInfo, default_task_configuration: DefaultTaskConfiguration)

Activity type details and default activity task configuration.

default_task_configuration: DefaultTaskConfiguration

Default task configuration, can be overriden when scheduling.

classmethod from_api(data) → ActivityDetails

Deserialise from SWF API response data.

info: ActivityInfo

Activity details.

class swf_typed.ActivityId(name: str, version: str)

Activity type identifier.

classmethod from_api(data) → ActivityId

Deserialise from SWF API response data.

name: str

Activity name.

to_api() → Dict[str, str]

Serialise to SWF API request data.

version: str

Activity version.

class swf_typed.ActivityIdFilter(name: str)

Activity type filter on activity name.

get_api_args()

Serialise to SWF API request arguments.

name: str

Activity name.

class swf_typed.ActivityInfo(activity: ActivityId, is_deprecated: bool, created: datetime, description: str = None, deprecated: datetime = None)

Activity type details.

activity: ActivityId

Activity name/version.

created: datetime

Creation date.

deprecated: datetime = None

Deprecation date.

description: str = None

Activity description.

classmethod from_api(data) → ActivityInfo

Deserialise from SWF API response data.

is_deprecated: bool

Activity is deprecated and not active.

class swf_typed.DefaultTaskConfiguration(task_list: str = None, runtime_timeout: timedelta | None = _Sentinel(), schedule_timeout: timedelta | None = _Sentinel(), total_timeout: timedelta | None = _Sentinel(), heartbeat_timeout: timedelta | None = _Sentinel(), priority: int = None)

Default activity task configuration.

classmethod from_api(data) → DefaultTaskConfiguration

Deserialise from SWF API response data.

get_api_args()

Serialise to SWF API request arguments.

heartbeat_timeout: timedelta | None = _Sentinel()

Heartbeat timeout.

priority: int = None

Task priority.

runtime_timeout: timedelta | None = _Sentinel()

Finish timeout.

schedule_timeout: timedelta | None = _Sentinel()

Start timeout.

task_list: str = None

Task task-list.

total_timeout: timedelta | None = _Sentinel()

Total finish timeout.

swf_typed.delete_activity(activity: ActivityId, domain: str, client: botocore.client.BaseClient = None) → None

Delete a (deprecated/inactive) activity type.

Parameters:

• activity – activity type to delete

• domain – domain of activity type

• client – SWF client

swf_typed.deprecate_activity(activity: ActivityId, domain: str, client: botocore.client.BaseClient = None) → None

Deprecate (deactivate) an activity type.

Parameters:

• activity – activity type to deprecate

• domain – domain of activity type

• client – SWF client

swf_typed.describe_activity(activity: ActivityId, domain: str, client: botocore.client.BaseClient = None) → ActivityDetails

Describe an activity type.

Parameters:

• activity – activity type to describe

• domain – domain of activity type

• client – SWF client

Returns:

activity type details and default activity task configuration

swf_typed.list_activities(domain: str, deprecated: bool = False, activity_filter: ActivityIdFilter = None, reverse: bool = False, client: botocore.client.BaseClient = None) → Generator[ActivityInfo, None, None]

List activity types; retrieved semi-lazily.

Parameters:

• domain – domain of activity types

• deprecated – list deprecated activity types instead of non-deprecated

• activity_filter – filter returned activity types by name

• reverse – return results in reverse alphabetical order

• client – SWF client

Returns:

matching activity types

swf_typed.register_activity(activity: ActivityId, domain: str, description: str = None, default_task_configuration: DefaultTaskConfiguration = None, client: botocore.client.BaseClient = None) → None

Register a new activity type.

Parameters:

• activity – activity type name and version

• domain – domain to register in

• description – activity type description

• default_task_configuration – default configuration for activity tasks with this activity type

• client – SWF client

swf_typed.undeprecate_activity(activity: ActivityId, domain: str, client: botocore.client.BaseClient = None) → None

Undeprecate (reactivate) an activity type.

Parameters:

• activity – activity type to undeprecate

• domain – domain of activity type

• client – SWF client