Skip to content

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.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#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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

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

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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:
    ...

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.