SWFClient

Index > SWF > SWFClient

Auto-generated documentation for SWF type annotations stubs module mypy-boto3-swf.

SWFClient

Type annotations and code completion for boto3.client("swf"). boto3 documentation

# SWFClient usage example

from boto3.session import Session
from mypy_boto3_swf.client import SWFClient

def get_swf_client() -> SWFClient:
    return Session().client("swf")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("swf").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("swf")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DefaultUndefinedFault,
    client.exceptions.DomainAlreadyExistsFault,
    client.exceptions.DomainDeprecatedFault,
    client.exceptions.LimitExceededFault,
    client.exceptions.OperationNotPermittedFault,
    client.exceptions.TooManyTagsFault,
    client.exceptions.TypeAlreadyExistsFault,
    client.exceptions.TypeDeprecatedFault,
    client.exceptions.TypeNotDeprecatedFault,
    client.exceptions.UnknownResourceFault,
    client.exceptions.WorkflowExecutionAlreadyStartedFault,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_swf.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("swf").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("swf").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

count_closed_workflow_executions

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

Type annotations and code completion for boto3.client("swf").count_closed_workflow_executions method. boto3 documentation

# count_closed_workflow_executions method definition

def count_closed_workflow_executions(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    closeTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (3)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (4)
    tagFilter: TagFilterTypeDef = ...,  # (5)
    closeStatusFilter: CloseStatusFilterTypeDef = ...,  # (6)
) -> WorkflowExecutionCountTypeDef:  # (7)
    ...

1. See ExecutionTimeFilterTypeDef
2. See ExecutionTimeFilterTypeDef
3. See WorkflowExecutionFilterTypeDef
4. See WorkflowTypeFilterTypeDef
5. See TagFilterTypeDef
6. See CloseStatusFilterTypeDef
7. See WorkflowExecutionCountTypeDef

# count_closed_workflow_executions method usage example with argument unpacking

kwargs: CountClosedWorkflowExecutionsInputRequestTypeDef = {  # (1)
    "domain": ...,
}

parent.count_closed_workflow_executions(**kwargs)

1. See CountClosedWorkflowExecutionsInputRequestTypeDef

count_open_workflow_executions

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

Type annotations and code completion for boto3.client("swf").count_open_workflow_executions method. boto3 documentation

# count_open_workflow_executions method definition

def count_open_workflow_executions(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef,  # (1)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (2)
    tagFilter: TagFilterTypeDef = ...,  # (3)
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (4)
) -> WorkflowExecutionCountTypeDef:  # (5)
    ...

1. See ExecutionTimeFilterTypeDef
2. See WorkflowTypeFilterTypeDef
3. See TagFilterTypeDef
4. See WorkflowExecutionFilterTypeDef
5. See WorkflowExecutionCountTypeDef

# count_open_workflow_executions method usage example with argument unpacking

kwargs: CountOpenWorkflowExecutionsInputRequestTypeDef = {  # (1)
    "domain": ...,
    "startTimeFilter": ...,
}

parent.count_open_workflow_executions(**kwargs)

1. See CountOpenWorkflowExecutionsInputRequestTypeDef

count_pending_activity_tasks

Returns the estimated number of activity tasks in the specified task list.

Type annotations and code completion for boto3.client("swf").count_pending_activity_tasks method. boto3 documentation

# count_pending_activity_tasks method definition

def count_pending_activity_tasks(
    self,
    *,
    domain: str,
    taskList: TaskListTypeDef,  # (1)
) -> PendingTaskCountTypeDef:  # (2)
    ...

1. See TaskListTypeDef
2. See PendingTaskCountTypeDef

# count_pending_activity_tasks method usage example with argument unpacking

kwargs: CountPendingActivityTasksInputRequestTypeDef = {  # (1)
    "domain": ...,
    "taskList": ...,
}

parent.count_pending_activity_tasks(**kwargs)

1. See CountPendingActivityTasksInputRequestTypeDef

count_pending_decision_tasks

Returns the estimated number of decision tasks in the specified task list.

Type annotations and code completion for boto3.client("swf").count_pending_decision_tasks method. boto3 documentation

# count_pending_decision_tasks method definition

def count_pending_decision_tasks(
    self,
    *,
    domain: str,
    taskList: TaskListTypeDef,  # (1)
) -> PendingTaskCountTypeDef:  # (2)
    ...

1. See TaskListTypeDef
2. See PendingTaskCountTypeDef

# count_pending_decision_tasks method usage example with argument unpacking

kwargs: CountPendingDecisionTasksInputRequestTypeDef = {  # (1)
    "domain": ...,
    "taskList": ...,
}

parent.count_pending_decision_tasks(**kwargs)

1. See CountPendingDecisionTasksInputRequestTypeDef

delete_activity_type

Deletes the specified activity type.

Type annotations and code completion for boto3.client("swf").delete_activity_type method. boto3 documentation

# delete_activity_type method definition

def delete_activity_type(
    self,
    *,
    domain: str,
    activityType: ActivityTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActivityTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# delete_activity_type method usage example with argument unpacking

kwargs: DeleteActivityTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "activityType": ...,
}

parent.delete_activity_type(**kwargs)

1. See DeleteActivityTypeInputRequestTypeDef

delete_workflow_type

Deletes the specified workflow type.

Type annotations and code completion for boto3.client("swf").delete_workflow_type method. boto3 documentation

# delete_workflow_type method definition

def delete_workflow_type(
    self,
    *,
    domain: str,
    workflowType: WorkflowTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See WorkflowTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# delete_workflow_type method usage example with argument unpacking

kwargs: DeleteWorkflowTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowType": ...,
}

parent.delete_workflow_type(**kwargs)

1. See DeleteWorkflowTypeInputRequestTypeDef

deprecate_activity_type

Deprecates the specified activity type.

Type annotations and code completion for boto3.client("swf").deprecate_activity_type method. boto3 documentation

# deprecate_activity_type method definition

def deprecate_activity_type(
    self,
    *,
    domain: str,
    activityType: ActivityTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActivityTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# deprecate_activity_type method usage example with argument unpacking

kwargs: DeprecateActivityTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "activityType": ...,
}

parent.deprecate_activity_type(**kwargs)

1. See DeprecateActivityTypeInputRequestTypeDef

deprecate_domain

Deprecates the specified domain.

Type annotations and code completion for boto3.client("swf").deprecate_domain method. boto3 documentation

# deprecate_domain method definition

def deprecate_domain(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deprecate_domain method usage example with argument unpacking

kwargs: DeprecateDomainInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.deprecate_domain(**kwargs)

1. See DeprecateDomainInputRequestTypeDef

deprecate_workflow_type

Deprecates the specified workflow type.

Type annotations and code completion for boto3.client("swf").deprecate_workflow_type method. boto3 documentation

# deprecate_workflow_type method definition

def deprecate_workflow_type(
    self,
    *,
    domain: str,
    workflowType: WorkflowTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See WorkflowTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# deprecate_workflow_type method usage example with argument unpacking

kwargs: DeprecateWorkflowTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowType": ...,
}

parent.deprecate_workflow_type(**kwargs)

1. See DeprecateWorkflowTypeInputRequestTypeDef

describe_activity_type

Returns information about the specified activity type.

Type annotations and code completion for boto3.client("swf").describe_activity_type method. boto3 documentation

# describe_activity_type method definition

def describe_activity_type(
    self,
    *,
    domain: str,
    activityType: ActivityTypeTypeDef,  # (1)
) -> ActivityTypeDetailTypeDef:  # (2)
    ...

1. See ActivityTypeTypeDef
2. See ActivityTypeDetailTypeDef

# describe_activity_type method usage example with argument unpacking

kwargs: DescribeActivityTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "activityType": ...,
}

parent.describe_activity_type(**kwargs)

1. See DescribeActivityTypeInputRequestTypeDef

describe_domain

Returns information about the specified domain, including description and status.

Type annotations and code completion for boto3.client("swf").describe_domain method. boto3 documentation

# describe_domain method definition

def describe_domain(
    self,
    *,
    name: str,
) -> DomainDetailTypeDef:  # (1)
    ...

1. See DomainDetailTypeDef

# describe_domain method usage example with argument unpacking

kwargs: DescribeDomainInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.describe_domain(**kwargs)

1. See DescribeDomainInputRequestTypeDef

describe_workflow_execution

Returns information about the specified workflow execution including its type and some statistics.

Type annotations and code completion for boto3.client("swf").describe_workflow_execution method. boto3 documentation

# describe_workflow_execution method definition

def describe_workflow_execution(
    self,
    *,
    domain: str,
    execution: WorkflowExecutionTypeDef,  # (1)
) -> WorkflowExecutionDetailTypeDef:  # (2)
    ...

1. See WorkflowExecutionTypeDef
2. See WorkflowExecutionDetailTypeDef

# describe_workflow_execution method usage example with argument unpacking

kwargs: DescribeWorkflowExecutionInputRequestTypeDef = {  # (1)
    "domain": ...,
    "execution": ...,
}

parent.describe_workflow_execution(**kwargs)

1. See DescribeWorkflowExecutionInputRequestTypeDef

describe_workflow_type

Returns information about the specified workflow type.

Type annotations and code completion for boto3.client("swf").describe_workflow_type method. boto3 documentation

# describe_workflow_type method definition

def describe_workflow_type(
    self,
    *,
    domain: str,
    workflowType: WorkflowTypeTypeDef,  # (1)
) -> WorkflowTypeDetailTypeDef:  # (2)
    ...

1. See WorkflowTypeTypeDef
2. See WorkflowTypeDetailTypeDef

# describe_workflow_type method usage example with argument unpacking

kwargs: DescribeWorkflowTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowType": ...,
}

parent.describe_workflow_type(**kwargs)

1. See DescribeWorkflowTypeInputRequestTypeDef

get_workflow_execution_history

Returns the history of the specified workflow execution.

Type annotations and code completion for boto3.client("swf").get_workflow_execution_history method. boto3 documentation

# get_workflow_execution_history method definition

def get_workflow_execution_history(
    self,
    *,
    domain: str,
    execution: WorkflowExecutionTypeDef,  # (1)
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
) -> HistoryTypeDef:  # (2)
    ...

1. See WorkflowExecutionTypeDef
2. See HistoryTypeDef

# get_workflow_execution_history method usage example with argument unpacking

kwargs: GetWorkflowExecutionHistoryInputRequestTypeDef = {  # (1)
    "domain": ...,
    "execution": ...,
}

parent.get_workflow_execution_history(**kwargs)

1. See GetWorkflowExecutionHistoryInputRequestTypeDef

list_activity_types

Returns information about all activities registered in the specified domain that match the specified name and registration status.

Type annotations and code completion for boto3.client("swf").list_activity_types method. boto3 documentation

# list_activity_types method definition

def list_activity_types(
    self,
    *,
    domain: str,
    registrationStatus: RegistrationStatusType,  # (1)
    name: str = ...,
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
) -> ActivityTypeInfosTypeDef:  # (2)
    ...

1. See RegistrationStatusType
2. See ActivityTypeInfosTypeDef

# list_activity_types method usage example with argument unpacking

kwargs: ListActivityTypesInputRequestTypeDef = {  # (1)
    "domain": ...,
    "registrationStatus": ...,
}

parent.list_activity_types(**kwargs)

1. See ListActivityTypesInputRequestTypeDef

list_closed_workflow_executions

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.

Type annotations and code completion for boto3.client("swf").list_closed_workflow_executions method. boto3 documentation

# list_closed_workflow_executions method definition

def list_closed_workflow_executions(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    closeTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (3)
    closeStatusFilter: CloseStatusFilterTypeDef = ...,  # (4)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (5)
    tagFilter: TagFilterTypeDef = ...,  # (6)
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
) -> WorkflowExecutionInfosTypeDef:  # (7)
    ...

1. See ExecutionTimeFilterTypeDef
2. See ExecutionTimeFilterTypeDef
3. See WorkflowExecutionFilterTypeDef
4. See CloseStatusFilterTypeDef
5. See WorkflowTypeFilterTypeDef
6. See TagFilterTypeDef
7. See WorkflowExecutionInfosTypeDef

# list_closed_workflow_executions method usage example with argument unpacking

kwargs: ListClosedWorkflowExecutionsInputRequestTypeDef = {  # (1)
    "domain": ...,
}

parent.list_closed_workflow_executions(**kwargs)

1. See ListClosedWorkflowExecutionsInputRequestTypeDef

list_domains

Returns the list of domains registered in the account.

Type annotations and code completion for boto3.client("swf").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    registrationStatus: RegistrationStatusType,  # (1)
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
) -> DomainInfosTypeDef:  # (2)
    ...

1. See RegistrationStatusType
2. See DomainInfosTypeDef

# list_domains method usage example with argument unpacking

kwargs: ListDomainsInputRequestTypeDef = {  # (1)
    "registrationStatus": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsInputRequestTypeDef

list_open_workflow_executions

Returns a list of open workflow executions in the specified domain that meet the filtering criteria.

Type annotations and code completion for boto3.client("swf").list_open_workflow_executions method. boto3 documentation

# list_open_workflow_executions method definition

def list_open_workflow_executions(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef,  # (1)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (2)
    tagFilter: TagFilterTypeDef = ...,  # (3)
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (4)
) -> WorkflowExecutionInfosTypeDef:  # (5)
    ...

1. See ExecutionTimeFilterTypeDef
2. See WorkflowTypeFilterTypeDef
3. See TagFilterTypeDef
4. See WorkflowExecutionFilterTypeDef
5. See WorkflowExecutionInfosTypeDef

# list_open_workflow_executions method usage example with argument unpacking

kwargs: ListOpenWorkflowExecutionsInputRequestTypeDef = {  # (1)
    "domain": ...,
    "startTimeFilter": ...,
}

parent.list_open_workflow_executions(**kwargs)

1. See ListOpenWorkflowExecutionsInputRequestTypeDef

list_tags_for_resource

List tags for a given domain.

Type annotations and code completion for boto3.client("swf").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

list_workflow_types

Returns information about workflow types in the specified domain.

Type annotations and code completion for boto3.client("swf").list_workflow_types method. boto3 documentation

# list_workflow_types method definition

def list_workflow_types(
    self,
    *,
    domain: str,
    registrationStatus: RegistrationStatusType,  # (1)
    name: str = ...,
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
) -> WorkflowTypeInfosTypeDef:  # (2)
    ...

1. See RegistrationStatusType
2. See WorkflowTypeInfosTypeDef

# list_workflow_types method usage example with argument unpacking

kwargs: ListWorkflowTypesInputRequestTypeDef = {  # (1)
    "domain": ...,
    "registrationStatus": ...,
}

parent.list_workflow_types(**kwargs)

1. See ListWorkflowTypesInputRequestTypeDef

poll_for_activity_task

Used by workers to get an ActivityTask from the specified activity taskList.

Type annotations and code completion for boto3.client("swf").poll_for_activity_task method. boto3 documentation

# poll_for_activity_task method definition

def poll_for_activity_task(
    self,
    *,
    domain: str,
    taskList: TaskListTypeDef,  # (1)
    identity: str = ...,
) -> ActivityTaskTypeDef:  # (2)
    ...

1. See TaskListTypeDef
2. See ActivityTaskTypeDef

# poll_for_activity_task method usage example with argument unpacking

kwargs: PollForActivityTaskInputRequestTypeDef = {  # (1)
    "domain": ...,
    "taskList": ...,
}

parent.poll_for_activity_task(**kwargs)

1. See PollForActivityTaskInputRequestTypeDef

poll_for_decision_task

Used by deciders to get a DecisionTask from the specified decision taskList.

Type annotations and code completion for boto3.client("swf").poll_for_decision_task method. boto3 documentation

# poll_for_decision_task method definition

def poll_for_decision_task(
    self,
    *,
    domain: str,
    taskList: TaskListTypeDef,  # (1)
    identity: str = ...,
    nextPageToken: str = ...,
    maximumPageSize: int = ...,
    reverseOrder: bool = ...,
    startAtPreviousStartedEvent: bool = ...,
) -> DecisionTaskTypeDef:  # (2)
    ...

1. See TaskListTypeDef
2. See DecisionTaskTypeDef

# poll_for_decision_task method usage example with argument unpacking

kwargs: PollForDecisionTaskInputRequestTypeDef = {  # (1)
    "domain": ...,
    "taskList": ...,
}

parent.poll_for_decision_task(**kwargs)

1. See PollForDecisionTaskInputRequestTypeDef

record_activity_task_heartbeat

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress.

Type annotations and code completion for boto3.client("swf").record_activity_task_heartbeat method. boto3 documentation

# record_activity_task_heartbeat method definition

def record_activity_task_heartbeat(
    self,
    *,
    taskToken: str,
    details: str = ...,
) -> ActivityTaskStatusTypeDef:  # (1)
    ...

1. See ActivityTaskStatusTypeDef

# record_activity_task_heartbeat method usage example with argument unpacking

kwargs: RecordActivityTaskHeartbeatInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.record_activity_task_heartbeat(**kwargs)

1. See RecordActivityTaskHeartbeatInputRequestTypeDef

register_activity_type

Registers a new activity type along with its configuration settings in the specified domain.

Type annotations and code completion for boto3.client("swf").register_activity_type method. boto3 documentation

# register_activity_type method definition

def register_activity_type(
    self,
    *,
    domain: str,
    name: str,
    version: str,
    description: str = ...,
    defaultTaskStartToCloseTimeout: str = ...,
    defaultTaskHeartbeatTimeout: str = ...,
    defaultTaskList: TaskListTypeDef = ...,  # (1)
    defaultTaskPriority: str = ...,
    defaultTaskScheduleToStartTimeout: str = ...,
    defaultTaskScheduleToCloseTimeout: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TaskListTypeDef
2. See EmptyResponseMetadataTypeDef

# register_activity_type method usage example with argument unpacking

kwargs: RegisterActivityTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "name": ...,
    "version": ...,
}

parent.register_activity_type(**kwargs)

1. See RegisterActivityTypeInputRequestTypeDef

register_domain

Registers a new domain.

Type annotations and code completion for boto3.client("swf").register_domain method. boto3 documentation

# register_domain method definition

def register_domain(
    self,
    *,
    name: str,
    workflowExecutionRetentionPeriodInDays: str,
    description: str = ...,
    tags: Sequence[ResourceTagTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ResourceTagTypeDef
2. See EmptyResponseMetadataTypeDef

# register_domain method usage example with argument unpacking

kwargs: RegisterDomainInputRequestTypeDef = {  # (1)
    "name": ...,
    "workflowExecutionRetentionPeriodInDays": ...,
}

parent.register_domain(**kwargs)

1. See RegisterDomainInputRequestTypeDef

register_workflow_type

Registers a new workflow type and its configuration settings in the specified domain.

Type annotations and code completion for boto3.client("swf").register_workflow_type method. boto3 documentation

# register_workflow_type method definition

def register_workflow_type(
    self,
    *,
    domain: str,
    name: str,
    version: str,
    description: str = ...,
    defaultTaskStartToCloseTimeout: str = ...,
    defaultExecutionStartToCloseTimeout: str = ...,
    defaultTaskList: TaskListTypeDef = ...,  # (1)
    defaultTaskPriority: str = ...,
    defaultChildPolicy: ChildPolicyType = ...,  # (2)
    defaultLambdaRole: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See TaskListTypeDef
2. See ChildPolicyType
3. See EmptyResponseMetadataTypeDef

# register_workflow_type method usage example with argument unpacking

kwargs: RegisterWorkflowTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "name": ...,
    "version": ...,
}

parent.register_workflow_type(**kwargs)

1. See RegisterWorkflowTypeInputRequestTypeDef

request_cancel_workflow_execution

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId.

Type annotations and code completion for boto3.client("swf").request_cancel_workflow_execution method. boto3 documentation

# request_cancel_workflow_execution method definition

def request_cancel_workflow_execution(
    self,
    *,
    domain: str,
    workflowId: str,
    runId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# request_cancel_workflow_execution method usage example with argument unpacking

kwargs: RequestCancelWorkflowExecutionInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowId": ...,
}

parent.request_cancel_workflow_execution(**kwargs)

1. See RequestCancelWorkflowExecutionInputRequestTypeDef

respond_activity_task_canceled

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled.

Type annotations and code completion for boto3.client("swf").respond_activity_task_canceled method. boto3 documentation

# respond_activity_task_canceled method definition

def respond_activity_task_canceled(
    self,
    *,
    taskToken: str,
    details: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# respond_activity_task_canceled method usage example with argument unpacking

kwargs: RespondActivityTaskCanceledInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.respond_activity_task_canceled(**kwargs)

1. See RespondActivityTaskCanceledInputRequestTypeDef

respond_activity_task_completed

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).

Type annotations and code completion for boto3.client("swf").respond_activity_task_completed method. boto3 documentation

# respond_activity_task_completed method definition

def respond_activity_task_completed(
    self,
    *,
    taskToken: str,
    result: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# respond_activity_task_completed method usage example with argument unpacking

kwargs: RespondActivityTaskCompletedInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.respond_activity_task_completed(**kwargs)

1. See RespondActivityTaskCompletedInputRequestTypeDef

respond_activity_task_failed

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).

Type annotations and code completion for boto3.client("swf").respond_activity_task_failed method. boto3 documentation

# respond_activity_task_failed method definition

def respond_activity_task_failed(
    self,
    *,
    taskToken: str,
    reason: str = ...,
    details: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# respond_activity_task_failed method usage example with argument unpacking

kwargs: RespondActivityTaskFailedInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.respond_activity_task_failed(**kwargs)

1. See RespondActivityTaskFailedInputRequestTypeDef

respond_decision_task_completed

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed.

Type annotations and code completion for boto3.client("swf").respond_decision_task_completed method. boto3 documentation

# respond_decision_task_completed method definition

def respond_decision_task_completed(
    self,
    *,
    taskToken: str,
    decisions: Sequence[DecisionTypeDef] = ...,  # (1)
    executionContext: str = ...,
    taskList: TaskListTypeDef = ...,  # (2)
    taskListScheduleToStartTimeout: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See DecisionTypeDef
2. See TaskListTypeDef
3. See EmptyResponseMetadataTypeDef

# respond_decision_task_completed method usage example with argument unpacking

kwargs: RespondDecisionTaskCompletedInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.respond_decision_task_completed(**kwargs)

1. See RespondDecisionTaskCompletedInputRequestTypeDef

signal_workflow_execution

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId.

Type annotations and code completion for boto3.client("swf").signal_workflow_execution method. boto3 documentation

# signal_workflow_execution method definition

def signal_workflow_execution(
    self,
    *,
    domain: str,
    workflowId: str,
    signalName: str,
    runId: str = ...,
    input: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# signal_workflow_execution method usage example with argument unpacking

kwargs: SignalWorkflowExecutionInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowId": ...,
    "signalName": ...,
}

parent.signal_workflow_execution(**kwargs)

1. See SignalWorkflowExecutionInputRequestTypeDef

start_workflow_execution

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

Type annotations and code completion for boto3.client("swf").start_workflow_execution method. boto3 documentation

# start_workflow_execution method definition

def start_workflow_execution(
    self,
    *,
    domain: str,
    workflowId: str,
    workflowType: WorkflowTypeTypeDef,  # (1)
    taskList: TaskListTypeDef = ...,  # (2)
    taskPriority: str = ...,
    input: str = ...,
    executionStartToCloseTimeout: str = ...,
    tagList: Sequence[str] = ...,
    taskStartToCloseTimeout: str = ...,
    childPolicy: ChildPolicyType = ...,  # (3)
    lambdaRole: str = ...,
) -> RunTypeDef:  # (4)
    ...

1. See WorkflowTypeTypeDef
2. See TaskListTypeDef
3. See ChildPolicyType
4. See RunTypeDef

# start_workflow_execution method usage example with argument unpacking

kwargs: StartWorkflowExecutionInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowId": ...,
    "workflowType": ...,
}

parent.start_workflow_execution(**kwargs)

1. See StartWorkflowExecutionInputRequestTypeDef

tag_resource

Add a tag to a Amazon SWF domain.

Type annotations and code completion for boto3.client("swf").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[ResourceTagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ResourceTagTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

terminate_workflow_execution

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId.

Type annotations and code completion for boto3.client("swf").terminate_workflow_execution method. boto3 documentation

# terminate_workflow_execution method definition

def terminate_workflow_execution(
    self,
    *,
    domain: str,
    workflowId: str,
    runId: str = ...,
    reason: str = ...,
    details: str = ...,
    childPolicy: ChildPolicyType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ChildPolicyType
2. See EmptyResponseMetadataTypeDef

# terminate_workflow_execution method usage example with argument unpacking

kwargs: TerminateWorkflowExecutionInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowId": ...,
}

parent.terminate_workflow_execution(**kwargs)

1. See TerminateWorkflowExecutionInputRequestTypeDef

undeprecate_activity_type

Undeprecates a previously deprecated activity type.

Type annotations and code completion for boto3.client("swf").undeprecate_activity_type method. boto3 documentation

# undeprecate_activity_type method definition

def undeprecate_activity_type(
    self,
    *,
    domain: str,
    activityType: ActivityTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActivityTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# undeprecate_activity_type method usage example with argument unpacking

kwargs: UndeprecateActivityTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "activityType": ...,
}

parent.undeprecate_activity_type(**kwargs)

1. See UndeprecateActivityTypeInputRequestTypeDef

undeprecate_domain

Undeprecates a previously deprecated domain.

Type annotations and code completion for boto3.client("swf").undeprecate_domain method. boto3 documentation

# undeprecate_domain method definition

def undeprecate_domain(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# undeprecate_domain method usage example with argument unpacking

kwargs: UndeprecateDomainInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.undeprecate_domain(**kwargs)

1. See UndeprecateDomainInputRequestTypeDef

undeprecate_workflow_type

Undeprecates a previously deprecated workflow type.

Type annotations and code completion for boto3.client("swf").undeprecate_workflow_type method. boto3 documentation

# undeprecate_workflow_type method definition

def undeprecate_workflow_type(
    self,
    *,
    domain: str,
    workflowType: WorkflowTypeTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See WorkflowTypeTypeDef
2. See EmptyResponseMetadataTypeDef

# undeprecate_workflow_type method usage example with argument unpacking

kwargs: UndeprecateWorkflowTypeInputRequestTypeDef = {  # (1)
    "domain": ...,
    "workflowType": ...,
}

parent.undeprecate_workflow_type(**kwargs)

1. See UndeprecateWorkflowTypeInputRequestTypeDef

untag_resource

Remove a tag from a Amazon SWF domain.

Type annotations and code completion for boto3.client("swf").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("swf").get_paginator method with overloads.

• client.get_paginator("get_workflow_execution_history") -> GetWorkflowExecutionHistoryPaginator
• client.get_paginator("list_activity_types") -> ListActivityTypesPaginator
• client.get_paginator("list_closed_workflow_executions") -> ListClosedWorkflowExecutionsPaginator
• client.get_paginator("list_domains") -> ListDomainsPaginator
• client.get_paginator("list_open_workflow_executions") -> ListOpenWorkflowExecutionsPaginator
• client.get_paginator("list_workflow_types") -> ListWorkflowTypesPaginator
• client.get_paginator("poll_for_decision_task") -> PollForDecisionTaskPaginator