SWF module#
Index > SWF
Auto-generated documentation for SWF type annotations stubs module types-boto3-swf.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
SWF
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SWF
.
From PyPI with pip#
Install types-boto3
for SWF
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[swf]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[swf]'
# standalone installation
python -m pip install types-boto3-swf
How to uninstall#
python -m pip uninstall -y types-boto3-swf
Usage#
Code samples can be found in Examples.
SWFClient#
Type annotations and code completion for boto3.client("swf")
as SWFClient
boto3 documentation
# SWFClient usage example
from boto3.session import Session
from types_boto3_swf.client import SWFClient
def get_client() -> SWFClient:
return Session().client("swf")
Paginators#
Type annotations and code completion for paginators
from boto3.client("swf").get_paginator("...")
.
# GetWorkflowExecutionHistoryPaginator usage example
from boto3.session import Session
from types_boto3_swf.paginator import GetWorkflowExecutionHistoryPaginator
def get_get_workflow_execution_history_paginator() -> GetWorkflowExecutionHistoryPaginator:
return Session().client("swf").get_paginator("get_workflow_execution_history"))
- GetWorkflowExecutionHistoryPaginator
- ListActivityTypesPaginator
- ListClosedWorkflowExecutionsPaginator
- ListDomainsPaginator
- ListOpenWorkflowExecutionsPaginator
- ListWorkflowTypesPaginator
- PollForDecisionTaskPaginator
Literals#
Type annotations for literals used in methods and schema.
# ActivityTaskTimeoutTypeType usage example
from types_boto3_swf.literals import ActivityTaskTimeoutTypeType
def get_value() -> ActivityTaskTimeoutTypeType:
return "HEARTBEAT"
- ActivityTaskTimeoutTypeType
- CancelTimerFailedCauseType
- CancelWorkflowExecutionFailedCauseType
- ChildPolicyType
- CloseStatusType
- CompleteWorkflowExecutionFailedCauseType
- ContinueAsNewWorkflowExecutionFailedCauseType
- DecisionTaskTimeoutTypeType
- DecisionTypeType
- EventTypeType
- ExecutionStatusType
- FailWorkflowExecutionFailedCauseType
- GetWorkflowExecutionHistoryPaginatorName
- LambdaFunctionTimeoutTypeType
- ListActivityTypesPaginatorName
- ListClosedWorkflowExecutionsPaginatorName
- ListDomainsPaginatorName
- ListOpenWorkflowExecutionsPaginatorName
- ListWorkflowTypesPaginatorName
- PollForDecisionTaskPaginatorName
- RecordMarkerFailedCauseType
- RegistrationStatusType
- RequestCancelActivityTaskFailedCauseType
- RequestCancelExternalWorkflowExecutionFailedCauseType
- ScheduleActivityTaskFailedCauseType
- ScheduleLambdaFunctionFailedCauseType
- SignalExternalWorkflowExecutionFailedCauseType
- StartChildWorkflowExecutionFailedCauseType
- StartLambdaFunctionFailedCauseType
- StartTimerFailedCauseType
- WorkflowExecutionCancelRequestedCauseType
- WorkflowExecutionTerminatedCauseType
- WorkflowExecutionTimeoutTypeType
- SWFServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActivityTaskCancelRequestedEventAttributesTypeDef
- ActivityTaskCanceledEventAttributesTypeDef
- ActivityTaskCompletedEventAttributesTypeDef
- ActivityTaskFailedEventAttributesTypeDef
- ActivityTypeTypeDef
- TaskListTypeDef
- ActivityTaskStartedEventAttributesTypeDef
- ResponseMetadataTypeDef
- ActivityTaskTimedOutEventAttributesTypeDef
- WorkflowExecutionTypeDef
- CancelTimerDecisionAttributesTypeDef
- CancelTimerFailedEventAttributesTypeDef
- CancelWorkflowExecutionDecisionAttributesTypeDef
- CancelWorkflowExecutionFailedEventAttributesTypeDef
- WorkflowTypeTypeDef
- CloseStatusFilterTypeDef
- CompleteWorkflowExecutionDecisionAttributesTypeDef
- CompleteWorkflowExecutionFailedEventAttributesTypeDef
- ContinueAsNewWorkflowExecutionFailedEventAttributesTypeDef
- TagFilterTypeDef
- WorkflowExecutionFilterTypeDef
- WorkflowTypeFilterTypeDef
- DecisionTaskStartedEventAttributesTypeDef
- DecisionTaskTimedOutEventAttributesTypeDef
- FailWorkflowExecutionDecisionAttributesTypeDef
- RecordMarkerDecisionAttributesTypeDef
- RequestCancelActivityTaskDecisionAttributesTypeDef
- RequestCancelExternalWorkflowExecutionDecisionAttributesTypeDef
- ScheduleLambdaFunctionDecisionAttributesTypeDef
- SignalExternalWorkflowExecutionDecisionAttributesTypeDef
- StartTimerDecisionAttributesTypeDef
- DeprecateDomainInputTypeDef
- DescribeDomainInputTypeDef
- DomainConfigurationTypeDef
- DomainInfoTypeDef
- TimestampTypeDef
- FailWorkflowExecutionFailedEventAttributesTypeDef
- PaginatorConfigTypeDef
- LambdaFunctionCompletedEventAttributesTypeDef
- LambdaFunctionFailedEventAttributesTypeDef
- LambdaFunctionScheduledEventAttributesTypeDef
- LambdaFunctionStartedEventAttributesTypeDef
- LambdaFunctionTimedOutEventAttributesTypeDef
- MarkerRecordedEventAttributesTypeDef
- RecordMarkerFailedEventAttributesTypeDef
- RequestCancelActivityTaskFailedEventAttributesTypeDef
- RequestCancelExternalWorkflowExecutionFailedEventAttributesTypeDef
- RequestCancelExternalWorkflowExecutionInitiatedEventAttributesTypeDef
- ScheduleLambdaFunctionFailedEventAttributesTypeDef
- SignalExternalWorkflowExecutionFailedEventAttributesTypeDef
- SignalExternalWorkflowExecutionInitiatedEventAttributesTypeDef
- StartLambdaFunctionFailedEventAttributesTypeDef
- StartTimerFailedEventAttributesTypeDef
- TimerCanceledEventAttributesTypeDef
- TimerFiredEventAttributesTypeDef
- TimerStartedEventAttributesTypeDef
- WorkflowExecutionCanceledEventAttributesTypeDef
- WorkflowExecutionCompletedEventAttributesTypeDef
- WorkflowExecutionFailedEventAttributesTypeDef
- WorkflowExecutionTerminatedEventAttributesTypeDef
- WorkflowExecutionTimedOutEventAttributesTypeDef
- ListActivityTypesInputTypeDef
- ListDomainsInputTypeDef
- ListTagsForResourceInputTypeDef
- ResourceTagTypeDef
- ListWorkflowTypesInputTypeDef
- RecordActivityTaskHeartbeatInputTypeDef
- RequestCancelWorkflowExecutionInputTypeDef
- RespondActivityTaskCanceledInputTypeDef
- RespondActivityTaskCompletedInputTypeDef
- RespondActivityTaskFailedInputTypeDef
- SignalWorkflowExecutionInputTypeDef
- TerminateWorkflowExecutionInputTypeDef
- UndeprecateDomainInputTypeDef
- UntagResourceInputTypeDef
- WorkflowExecutionOpenCountsTypeDef
- ActivityTypeInfoTypeDef
- DeleteActivityTypeInputTypeDef
- DeprecateActivityTypeInputTypeDef
- DescribeActivityTypeInputTypeDef
- ScheduleActivityTaskFailedEventAttributesTypeDef
- UndeprecateActivityTypeInputTypeDef
- ActivityTaskScheduledEventAttributesTypeDef
- ActivityTypeConfigurationTypeDef
- ContinueAsNewWorkflowExecutionDecisionAttributesTypeDef
- CountPendingActivityTasksInputTypeDef
- CountPendingDecisionTasksInputTypeDef
- DecisionTaskCompletedEventAttributesTypeDef
- DecisionTaskScheduledEventAttributesTypeDef
- PollForActivityTaskInputTypeDef
- PollForDecisionTaskInputTypeDef
- RegisterActivityTypeInputTypeDef
- RegisterWorkflowTypeInputTypeDef
- ScheduleActivityTaskDecisionAttributesTypeDef
- WorkflowExecutionConfigurationTypeDef
- WorkflowTypeConfigurationTypeDef
- ActivityTaskStatusTypeDef
- EmptyResponseMetadataTypeDef
- PendingTaskCountTypeDef
- RunTypeDef
- WorkflowExecutionCountTypeDef
- ActivityTaskTypeDef
- DescribeWorkflowExecutionInputTypeDef
- ExternalWorkflowExecutionCancelRequestedEventAttributesTypeDef
- ExternalWorkflowExecutionSignaledEventAttributesTypeDef
- GetWorkflowExecutionHistoryInputTypeDef
- WorkflowExecutionCancelRequestedEventAttributesTypeDef
- WorkflowExecutionSignaledEventAttributesTypeDef
- ChildWorkflowExecutionCanceledEventAttributesTypeDef
- ChildWorkflowExecutionCompletedEventAttributesTypeDef
- ChildWorkflowExecutionFailedEventAttributesTypeDef
- ChildWorkflowExecutionStartedEventAttributesTypeDef
- ChildWorkflowExecutionTerminatedEventAttributesTypeDef
- ChildWorkflowExecutionTimedOutEventAttributesTypeDef
- DeleteWorkflowTypeInputTypeDef
- DeprecateWorkflowTypeInputTypeDef
- DescribeWorkflowTypeInputTypeDef
- StartChildWorkflowExecutionDecisionAttributesTypeDef
- StartChildWorkflowExecutionFailedEventAttributesTypeDef
- StartChildWorkflowExecutionInitiatedEventAttributesTypeDef
- StartWorkflowExecutionInputTypeDef
- UndeprecateWorkflowTypeInputTypeDef
- WorkflowExecutionContinuedAsNewEventAttributesTypeDef
- WorkflowExecutionInfoTypeDef
- WorkflowExecutionStartedEventAttributesTypeDef
- WorkflowTypeInfoTypeDef
- DomainDetailTypeDef
- DomainInfosTypeDef
- ExecutionTimeFilterTypeDef
- GetWorkflowExecutionHistoryInputPaginateTypeDef
- ListActivityTypesInputPaginateTypeDef
- ListDomainsInputPaginateTypeDef
- ListWorkflowTypesInputPaginateTypeDef
- PollForDecisionTaskInputPaginateTypeDef
- ListTagsForResourceOutputTypeDef
- RegisterDomainInputTypeDef
- TagResourceInputTypeDef
- ActivityTypeInfosTypeDef
- ActivityTypeDetailTypeDef
- DecisionTypeDef
- WorkflowExecutionDetailTypeDef
- WorkflowExecutionInfosTypeDef
- HistoryEventTypeDef
- WorkflowTypeDetailTypeDef
- WorkflowTypeInfosTypeDef
- CountClosedWorkflowExecutionsInputTypeDef
- CountOpenWorkflowExecutionsInputTypeDef
- ListClosedWorkflowExecutionsInputPaginateTypeDef
- ListClosedWorkflowExecutionsInputTypeDef
- ListOpenWorkflowExecutionsInputPaginateTypeDef
- ListOpenWorkflowExecutionsInputTypeDef
- RespondDecisionTaskCompletedInputTypeDef
- DecisionTaskTypeDef
- HistoryTypeDef