Struct aws_sdk_swf::Client

pub struct Client { /* private fields */ }

Client for Amazon Simple Workflow Service

Client for invoking operations on Amazon Simple Workflow Service. Each operation on Amazon Simple Workflow Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_swf::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_swf::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CountClosedWorkflowExecutions operation has a Client::count_closed_workflow_executions, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.count_closed_workflow_executions()
    .domain("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn count_closed_workflow_executions( &self ) -> CountClosedWorkflowExecutionsFluentBuilder

Constructs a fluent builder for the CountClosedWorkflowExecutions operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow executions to count.

    
    
  • start_time_filter(ExecutionTimeFilter) / set_start_time_filter(Option<ExecutionTimeFilter>):
    required: false
    

    If specified, only workflow executions that meet the start time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    
    
  • close_time_filter(ExecutionTimeFilter) / set_close_time_filter(Option<ExecutionTimeFilter>):
    required: false
    

    If specified, only workflow executions that meet the close time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    
    
  • execution_filter(WorkflowExecutionFilter) / set_execution_filter(Option<WorkflowExecutionFilter>):
    required: false
    

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • type_filter(WorkflowTypeFilter) / set_type_filter(Option<WorkflowTypeFilter>):
    required: false
    

    If specified, indicates the type of the workflow executions to be counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • tag_filter(TagFilter) / set_tag_filter(Option<TagFilter>):
    required: false
    

    If specified, only executions that have a tag that matches the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • close_status_filter(CloseStatusFilter) / set_close_status_filter(Option<CloseStatusFilter>):
    required: false
    

    If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
• On success, responds with CountClosedWorkflowExecutionsOutput with field(s):
  • count(i32):

    The number of workflow executions.

  • truncated(bool):

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

• On failure, responds with SdkError<CountClosedWorkflowExecutionsError>

impl Client

pub fn count_open_workflow_executions( &self ) -> CountOpenWorkflowExecutionsFluentBuilder

Constructs a fluent builder for the CountOpenWorkflowExecutions operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow executions to count.

    
    
  • start_time_filter(ExecutionTimeFilter) / set_start_time_filter(Option<ExecutionTimeFilter>):
    required: true
    

    Specifies the start time criteria that workflow executions must meet in order to be counted.

    
    
  • type_filter(WorkflowTypeFilter) / set_type_filter(Option<WorkflowTypeFilter>):
    required: false
    

    Specifies the type of the workflow executions to be counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • tag_filter(TagFilter) / set_tag_filter(Option<TagFilter>):
    required: false
    

    If specified, only executions that have a tag that matches the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • execution_filter(WorkflowExecutionFilter) / set_execution_filter(Option<WorkflowExecutionFilter>):
    required: false
    

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
• On success, responds with CountOpenWorkflowExecutionsOutput with field(s):
  • count(i32):

    The number of workflow executions.

  • truncated(bool):

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

• On failure, responds with SdkError<CountOpenWorkflowExecutionsError>

impl Client

pub fn count_pending_activity_tasks( &self ) -> CountPendingActivityTasksFluentBuilder

Constructs a fluent builder for the CountPendingActivityTasks operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain that contains the task list.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: true
    

    The name of the task list.

    
    
• On success, responds with CountPendingActivityTasksOutput with field(s):
  • count(i32):

    The number of tasks in the task list.

  • truncated(bool):

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

• On failure, responds with SdkError<CountPendingActivityTasksError>

impl Client

pub fn count_pending_decision_tasks( &self ) -> CountPendingDecisionTasksFluentBuilder

Constructs a fluent builder for the CountPendingDecisionTasks operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain that contains the task list.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: true
    

    The name of the task list.

    
    
• On success, responds with CountPendingDecisionTasksOutput with field(s):
  • count(i32):

    The number of tasks in the task list.

  • truncated(bool):

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

• On failure, responds with SdkError<CountPendingDecisionTasksError>

impl Client

pub fn deprecate_activity_type(&self) -> DeprecateActivityTypeFluentBuilder

Constructs a fluent builder for the DeprecateActivityType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the activity type is registered.

    
    
  • activity_type(ActivityType) / set_activity_type(Option<ActivityType>):
    required: true
    

    The activity type to deprecate.

    
    
• On success, responds with DeprecateActivityTypeOutput
• On failure, responds with SdkError<DeprecateActivityTypeError>

impl Client

pub fn deprecate_domain(&self) -> DeprecateDomainFluentBuilder

Constructs a fluent builder for the DeprecateDomain operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the domain to deprecate.

    
    
• On success, responds with DeprecateDomainOutput
• On failure, responds with SdkError<DeprecateDomainError>

impl Client

pub fn deprecate_workflow_type(&self) -> DeprecateWorkflowTypeFluentBuilder

Constructs a fluent builder for the DeprecateWorkflowType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the workflow type is registered.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: true
    

    The workflow type to deprecate.

    
    
• On success, responds with DeprecateWorkflowTypeOutput
• On failure, responds with SdkError<DeprecateWorkflowTypeError>

impl Client

pub fn describe_activity_type(&self) -> DescribeActivityTypeFluentBuilder

Constructs a fluent builder for the DescribeActivityType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the activity type is registered.

    
    
  • activity_type(ActivityType) / set_activity_type(Option<ActivityType>):
    required: true
    

    The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

    
    
• On success, responds with DescribeActivityTypeOutput with field(s):
  • type_info(Option<ActivityTypeInfo>):

    General information about the activity type.

    The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

    • REGISTERED – The type is registered and available. Workers supporting this type should be running.

    • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

  • configuration(Option<ActivityTypeConfiguration>):

    The configuration settings registered with the activity type.

• On failure, responds with SdkError<DescribeActivityTypeError>

impl Client

pub fn describe_domain(&self) -> DescribeDomainFluentBuilder

Constructs a fluent builder for the DescribeDomain operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the domain to describe.

    
    
• On success, responds with DescribeDomainOutput with field(s):
  • domain_info(Option<DomainInfo>):

    The basic information about a domain, such as its name, status, and description.

  • configuration(Option<DomainConfiguration>):

    The domain configuration. Currently, this includes only the domain’s retention period.

• On failure, responds with SdkError<DescribeDomainError>

impl Client

pub fn describe_workflow_execution( &self ) -> DescribeWorkflowExecutionFluentBuilder

Constructs a fluent builder for the DescribeWorkflowExecution operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow execution.

    
    
  • execution(WorkflowExecution) / set_execution(Option<WorkflowExecution>):
    required: true
    

    The workflow execution to describe.

    
    
• On success, responds with DescribeWorkflowExecutionOutput with field(s):
  • execution_info(Option<WorkflowExecutionInfo>):

    Information about the workflow execution.

  • execution_configuration(Option<WorkflowExecutionConfiguration>):

    The configuration settings for this workflow execution including timeout values, tasklist etc.

  • open_counts(Option<WorkflowExecutionOpenCounts>):

    The number of tasks for this workflow execution. This includes open and closed tasks of all types.

  • latest_activity_task_timestamp(Option<DateTime>):

    The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

  • latest_execution_context(Option<String>):

    The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

• On failure, responds with SdkError<DescribeWorkflowExecutionError>

impl Client

pub fn describe_workflow_type(&self) -> DescribeWorkflowTypeFluentBuilder

Constructs a fluent builder for the DescribeWorkflowType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which this workflow type is registered.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: true
    

    The workflow type to describe.

    
    
• On success, responds with DescribeWorkflowTypeOutput with field(s):
  • type_info(Option<WorkflowTypeInfo>):

    General information about the workflow type.

    The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

    • REGISTERED – The type is registered and available. Workers supporting this type should be running.

    • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

  • configuration(Option<WorkflowTypeConfiguration>):

    Configuration settings of the workflow type registered through RegisterWorkflowType

• On failure, responds with SdkError<DescribeWorkflowTypeError>

impl Client

pub fn get_workflow_execution_history( &self ) -> GetWorkflowExecutionHistoryFluentBuilder

Constructs a fluent builder for the GetWorkflowExecutionHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow execution.

    
    
  • execution(WorkflowExecution) / set_execution(Option<WorkflowExecution>):
    required: true
    

    Specifies the workflow execution for which to return the history.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

    
    
• On success, responds with GetWorkflowExecutionHistoryOutput with field(s):
  • events(Vec::<HistoryEvent>):

    The list of history events.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<GetWorkflowExecutionHistoryError>

impl Client

pub fn list_activity_types(&self) -> ListActivityTypesFluentBuilder

Constructs a fluent builder for the ListActivityTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the activity types have been registered.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    If specified, only lists the activity types that have this name.

    
    
  • registration_status(RegistrationStatus) / set_registration_status(Option<RegistrationStatus>):
    required: true
    

    Specifies the registration status of the activity types to list.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

    
    
• On success, responds with ListActivityTypesOutput with field(s):
  • type_infos(Vec::<ActivityTypeInfo>):

    List of activity type information.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<ListActivityTypesError>

impl Client

pub fn list_closed_workflow_executions( &self ) -> ListClosedWorkflowExecutionsFluentBuilder

Constructs a fluent builder for the ListClosedWorkflowExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain that contains the workflow executions to list.

    
    
  • start_time_filter(ExecutionTimeFilter) / set_start_time_filter(Option<ExecutionTimeFilter>):
    required: false
    

    If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    
    
  • close_time_filter(ExecutionTimeFilter) / set_close_time_filter(Option<ExecutionTimeFilter>):
    required: false
    

    If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    
    
  • execution_filter(WorkflowExecutionFilter) / set_execution_filter(Option<WorkflowExecutionFilter>):
    required: false
    

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • close_status_filter(CloseStatusFilter) / set_close_status_filter(Option<CloseStatusFilter>):
    required: false
    

    If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • type_filter(WorkflowTypeFilter) / set_type_filter(Option<WorkflowTypeFilter>):
    required: false
    

    If specified, only executions of the type specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • tag_filter(TagFilter) / set_tag_filter(Option<TagFilter>):
    required: false
    

    If specified, only executions that have the matching tag are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    
    
• On success, responds with ListClosedWorkflowExecutionsOutput with field(s):
  • execution_infos(Vec::<WorkflowExecutionInfo>):

    The list of workflow information structures.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<ListClosedWorkflowExecutionsError>

impl Client

pub fn list_domains(&self) -> ListDomainsFluentBuilder

Constructs a fluent builder for the ListDomains operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • registration_status(RegistrationStatus) / set_registration_status(Option<RegistrationStatus>):
    required: true
    

    Specifies the registration status of the domains to list.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

    
    
• On success, responds with ListDomainsOutput with field(s):
  • domain_infos(Vec::<DomainInfo>):

    A list of DomainInfo structures.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<ListDomainsError>

impl Client

pub fn list_open_workflow_executions( &self ) -> ListOpenWorkflowExecutionsFluentBuilder

Constructs a fluent builder for the ListOpenWorkflowExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain that contains the workflow executions to list.

    
    
  • start_time_filter(ExecutionTimeFilter) / set_start_time_filter(Option<ExecutionTimeFilter>):
    required: true
    

    Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    
    
  • type_filter(WorkflowTypeFilter) / set_type_filter(Option<WorkflowTypeFilter>):
    required: false
    

    If specified, only executions of the type specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • tag_filter(TagFilter) / set_tag_filter(Option<TagFilter>):
    required: false
    

    If specified, only executions that have the matching tag are listed.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

    
    
  • execution_filter(WorkflowExecutionFilter) / set_execution_filter(Option<WorkflowExecutionFilter>):
    required: false
    

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    
    
• On success, responds with ListOpenWorkflowExecutionsOutput with field(s):
  • execution_infos(Vec::<WorkflowExecutionInfo>):

    The list of workflow information structures.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<ListOpenWorkflowExecutionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<ResourceTag>>):

    An array of tags associated with the domain.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_workflow_types(&self) -> ListWorkflowTypesFluentBuilder

Constructs a fluent builder for the ListWorkflowTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the workflow types have been registered.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    If specified, lists the workflow type with this name.

    
    
  • registration_status(RegistrationStatus) / set_registration_status(Option<RegistrationStatus>):
    required: true
    

    Specifies the registration status of the workflow types to list.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

    
    
• On success, responds with ListWorkflowTypesOutput with field(s):
  • type_infos(Vec::<WorkflowTypeInfo>):

    The list of workflow type information.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

• On failure, responds with SdkError<ListWorkflowTypesError>

impl Client

pub fn poll_for_activity_task(&self) -> PollForActivityTaskFluentBuilder

Constructs a fluent builder for the PollForActivityTask operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain that contains the task lists being polled.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: true
    

    Specifies the task list to poll for activity tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • identity(impl Into<String>) / set_identity(Option<String>):
    required: false
    

    Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    
    
• On success, responds with PollForActivityTaskOutput with field(s):
  • task_token(String):

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

  • activity_id(String):

    The unique ID of the task.

  • started_event_id(i64):

    The ID of the ActivityTaskStarted event recorded in the history.

  • workflow_execution(Option<WorkflowExecution>):

    The workflow execution that started this activity task.

  • activity_type(Option<ActivityType>):

    The type of this activity task.

  • input(Option<String>):

    The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

• On failure, responds with SdkError<PollForActivityTaskError>

impl Client

pub fn poll_for_decision_task(&self) -> PollForDecisionTaskFluentBuilder

Constructs a fluent builder for the PollForDecisionTask operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the task lists to poll.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: true
    

    Specifies the task list to poll for decision tasks.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • identity(impl Into<String>) / set_identity(Option<String>):
    required: false
    

    Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    
    
  • next_page_token(impl Into<String>) / set_next_page_token(Option<String>):
    required: false
    

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: “Specified token has exceeded its maximum lifetime”.

    The configured maximumPageSize determines how many results can be returned in a single call.

    The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn’t return a new decision task.

    
    
  • maximum_page_size(i32) / set_maximum_page_size(Option<i32>):
    required: false
    

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

    
    
  • start_at_previous_started_event(bool) / set_start_at_previous_started_event(Option<bool>):
    required: false
    

    When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

    
    
• On success, responds with PollForDecisionTaskOutput with field(s):
  • task_token(String):

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

  • started_event_id(i64):

    The ID of the DecisionTaskStarted event recorded in the history.

  • workflow_execution(Option<WorkflowExecution>):

    The workflow execution for which this decision task was created.

  • workflow_type(Option<WorkflowType>):

    The type of the workflow execution for which this decision task was created.

  • events(Vec::<HistoryEvent>):

    A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

  • next_page_token(Option<String>):

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • previous_started_event_id(i64):

    The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

• On failure, responds with SdkError<PollForDecisionTaskError>

impl Client

pub fn record_activity_task_heartbeat( &self ) -> RecordActivityTaskHeartbeatFluentBuilder

Constructs a fluent builder for the RecordActivityTaskHeartbeat operation.

• The fluent builder is configurable:
  • task_token(impl Into<String>) / set_task_token(Option<String>):
    required: true
    

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    
    
  • details(impl Into<String>) / set_details(Option<String>):
    required: false
    

    If specified, contains details about the progress of the task.

    
    
• On success, responds with RecordActivityTaskHeartbeatOutput with field(s):
  • cancel_requested(bool):

    Set to true if cancellation of the task is requested.

• On failure, responds with SdkError<RecordActivityTaskHeartbeatError>

impl Client

pub fn register_activity_type(&self) -> RegisterActivityTypeFluentBuilder

Constructs a fluent builder for the RegisterActivityType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which this activity is to be registered.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the activity type within the domain.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    The version of the activity type.

    The activity type consists of the name and version, the combination of which must be unique within the domain.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A textual description of the activity type.

    
    
  • default_task_start_to_close_timeout(impl Into<String>) / set_default_task_start_to_close_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    
    
  • default_task_heartbeat_timeout(impl Into<String>) / set_default_task_heartbeat_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    
    
  • default_task_list(TaskList) / set_default_task_list(Option<TaskList>):
    required: false
    

    If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn’t provided when a task is scheduled through the ScheduleActivityTask Decision.

    
    
  • default_task_priority(impl Into<String>) / set_default_task_priority(Option<String>):
    required: false
    

    The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java’s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

    
    
  • default_task_schedule_to_start_timeout(impl Into<String>) / set_default_task_schedule_to_start_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    
    
  • default_task_schedule_to_close_timeout(impl Into<String>) / set_default_task_schedule_to_close_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    
    
• On success, responds with RegisterActivityTypeOutput
• On failure, responds with SdkError<RegisterActivityTypeError>

impl Client

pub fn register_domain(&self) -> RegisterDomainFluentBuilder

Constructs a fluent builder for the RegisterDomain operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of the domain to register. The name must be unique in the region that the domain is registered in.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A text description of the domain.

    
    
  • workflow_execution_retention_period_in_days(impl Into<String>) / set_workflow_execution_retention_period_in_days(Option<String>):
    required: true
    

    The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn’t available in the results of visibility calls.

    If you pass the value NONE or 0 (zero), then the workflow execution history isn’t retained. As soon as the workflow execution completes, the execution record and its history are deleted.

    The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

    
    
  • tags(ResourceTag) / set_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    Tags to be added when registering a domain.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    
    
• On success, responds with RegisterDomainOutput
• On failure, responds with SdkError<RegisterDomainError>

impl Client

pub fn register_workflow_type(&self) -> RegisterWorkflowTypeFluentBuilder

Constructs a fluent builder for the RegisterWorkflowType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which to register the workflow type.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workflow type.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    The version of the workflow type.

    The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Textual description of the workflow type.

    
    
  • default_task_start_to_close_timeout(impl Into<String>) / set_default_task_start_to_close_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    
    
  • default_execution_start_to_close_timeout(impl Into<String>) / set_default_execution_start_to_close_timeout(Option<String>):
    required: false
    

    If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

    The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of “NONE” for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

    
    
  • default_task_list(TaskList) / set_default_task_list(Option<TaskList>):
    required: false
    

    If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn’t provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

    
    
  • default_task_priority(impl Into<String>) / set_default_task_priority(Option<String>):
    required: false
    

    The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java’s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    
    
  • default_child_policy(ChildPolicy) / set_default_child_policy(Option<ChildPolicy>):
    required: false
    

    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    
    
  • default_lambda_role(impl Into<String>) / set_default_lambda_role(Option<String>):
    required: false
    

    The default IAM role attached to this workflow type.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don’t specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

    
    
• On success, responds with RegisterWorkflowTypeOutput
• On failure, responds with SdkError<RegisterWorkflowTypeError>

impl Client

pub fn request_cancel_workflow_execution( &self ) -> RequestCancelWorkflowExecutionFluentBuilder

Constructs a fluent builder for the RequestCancelWorkflowExecution operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow execution to cancel.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflowId of the workflow execution to cancel.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: false
    

    The runId of the workflow execution to cancel.

    
    
• On success, responds with RequestCancelWorkflowExecutionOutput
• On failure, responds with SdkError<RequestCancelWorkflowExecutionError>

impl Client

pub fn respond_activity_task_canceled( &self ) -> RespondActivityTaskCanceledFluentBuilder

Constructs a fluent builder for the RespondActivityTaskCanceled operation.

• The fluent builder is configurable:
  • task_token(impl Into<String>) / set_task_token(Option<String>):
    required: true
    

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    
    
  • details(impl Into<String>) / set_details(Option<String>):
    required: false
    

    Information about the cancellation.

    
    
• On success, responds with RespondActivityTaskCanceledOutput
• On failure, responds with SdkError<RespondActivityTaskCanceledError>

impl Client

pub fn respond_activity_task_completed( &self ) -> RespondActivityTaskCompletedFluentBuilder

Constructs a fluent builder for the RespondActivityTaskCompleted operation.

• The fluent builder is configurable:
  • task_token(impl Into<String>) / set_task_token(Option<String>):
    required: true
    

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    
    
  • result(impl Into<String>) / set_result(Option<String>):
    required: false
    

    The result of the activity task. It is a free form string that is implementation specific.

    
    
• On success, responds with RespondActivityTaskCompletedOutput
• On failure, responds with SdkError<RespondActivityTaskCompletedError>

impl Client

pub fn respond_activity_task_failed( &self ) -> RespondActivityTaskFailedFluentBuilder

Constructs a fluent builder for the RespondActivityTaskFailed operation.

• The fluent builder is configurable:
  • task_token(impl Into<String>) / set_task_token(Option<String>):
    required: true
    

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    Description of the error that may assist in diagnostics.

    
    
  • details(impl Into<String>) / set_details(Option<String>):
    required: false
    

    Detailed information about the failure.

    
    
• On success, responds with RespondActivityTaskFailedOutput
• On failure, responds with SdkError<RespondActivityTaskFailedError>

impl Client

pub fn respond_decision_task_completed( &self ) -> RespondDecisionTaskCompletedFluentBuilder

Constructs a fluent builder for the RespondDecisionTaskCompleted operation.

• The fluent builder is configurable:
  • task_token(impl Into<String>) / set_task_token(Option<String>):
    required: true
    

    The taskToken from the DecisionTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    
    
  • decisions(Decision) / set_decisions(Option<Vec::<Decision>>):
    required: false
    

    The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

    
    
  • execution_context(impl Into<String>) / set_execution_context(Option<String>):
    required: false
    

    User defined context to add to workflow execution.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: false
    

    The task list to use for the future decision tasks of this workflow execution. This list overrides the original task list you specified while starting the workflow execution.

    
    
  • task_list_schedule_to_start_timeout(impl Into<String>) / set_task_list_schedule_to_start_timeout(Option<String>):
    required: false
    

    Specifies a timeout (in seconds) for the task list override. When this parameter is missing, the task list override is permanent. This parameter makes it possible to temporarily override the task list. If a decision task scheduled on the override task list is not started within the timeout, the decision task will time out. Amazon SWF will revert the override and schedule a new decision task to the original task list.

    If a decision task scheduled on the override task list is started within the timeout, but not completed within the start-to-close timeout, Amazon SWF will also revert the override and schedule a new decision task to the original task list.

    
    
• On success, responds with RespondDecisionTaskCompletedOutput
• On failure, responds with SdkError<RespondDecisionTaskCompletedError>

impl Client

pub fn signal_workflow_execution(&self) -> SignalWorkflowExecutionFluentBuilder

Constructs a fluent builder for the SignalWorkflowExecution operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain containing the workflow execution to signal.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflowId of the workflow execution to signal.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: false
    

    The runId of the workflow execution to signal.

    
    
  • signal_name(impl Into<String>) / set_signal_name(Option<String>):
    required: true
    

    The name of the signal. This name must be meaningful to the target workflow.

    
    
  • input(impl Into<String>) / set_input(Option<String>):
    required: false
    

    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution’s history.

    
    
• On success, responds with SignalWorkflowExecutionOutput
• On failure, responds with SdkError<SignalWorkflowExecutionError>

impl Client

pub fn start_workflow_execution(&self) -> StartWorkflowExecutionFluentBuilder

Constructs a fluent builder for the StartWorkflowExecution operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain in which the workflow execution is created.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: true
    

    The type of the workflow to start.

    
    
  • task_list(TaskList) / set_task_list(Option<TaskList>):
    required: false
    

    The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

    
    
  • task_priority(impl Into<String>) / set_task_priority(Option<String>):
    required: false
    

    The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java’s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    
    
  • input(impl Into<String>) / set_input(Option<String>):
    required: false
    

    The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

    
    
  • execution_start_to_close_timeout(impl Into<String>) / set_execution_start_to_close_timeout(Option<String>):
    required: false
    

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of “NONE” for this timeout; there is a one-year max limit on the time that a workflow execution can run.

    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

    
    
  • tag_list(impl Into<String>) / set_tag_list(Option<Vec::<String>>):
    required: false
    

    The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

    
    
  • task_start_to_close_timeout(impl Into<String>) / set_task_start_to_close_timeout(Option<String>):
    required: false
    

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    
    
  • child_policy(ChildPolicy) / set_child_policy(Option<ChildPolicy>):
    required: false
    

    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    
    
  • lambda_role(impl Into<String>) / set_lambda_role(Option<String>):
    required: false
    

    The IAM role to attach to this workflow execution.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don’t attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

    
    
• On success, responds with StartWorkflowExecutionOutput with field(s):
  • run_id(Option<String>):

    The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

• On failure, responds with SdkError<StartWorkflowExecutionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    
    
  • tags(ResourceTag) / set_tags(Option<Vec::<ResourceTag>>):
    required: true
    

    The list of tags to add to a domain.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn terminate_workflow_execution( &self ) -> TerminateWorkflowExecutionFluentBuilder

Constructs a fluent builder for the TerminateWorkflowExecution operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The domain of the workflow execution to terminate.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The workflowId of the workflow execution to terminate.

    
    
  • run_id(impl Into<String>) / set_run_id(Option<String>):
    required: false
    

    The runId of the workflow execution to terminate.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    A descriptive reason for terminating the workflow execution.

    
    
  • details(impl Into<String>) / set_details(Option<String>):
    required: false
    

    Details for terminating the workflow execution.

    
    
  • child_policy(ChildPolicy) / set_child_policy(Option<ChildPolicy>):
    required: false
    

    If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    
    
• On success, responds with TerminateWorkflowExecutionOutput
• On failure, responds with SdkError<TerminateWorkflowExecutionError>

impl Client

pub fn undeprecate_activity_type(&self) -> UndeprecateActivityTypeFluentBuilder

Constructs a fluent builder for the UndeprecateActivityType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the deprecated activity type.

    
    
  • activity_type(ActivityType) / set_activity_type(Option<ActivityType>):
    required: true
    

    The activity type to undeprecate.

    
    
• On success, responds with UndeprecateActivityTypeOutput
• On failure, responds with SdkError<UndeprecateActivityTypeError>

impl Client

pub fn undeprecate_domain(&self) -> UndeprecateDomainFluentBuilder

Constructs a fluent builder for the UndeprecateDomain operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the domain of the deprecated workflow type.

    
    
• On success, responds with UndeprecateDomainOutput
• On failure, responds with SdkError<UndeprecateDomainError>

impl Client

pub fn undeprecate_workflow_type(&self) -> UndeprecateWorkflowTypeFluentBuilder

Constructs a fluent builder for the UndeprecateWorkflowType operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the deprecated workflow type.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: true
    

    The name of the domain of the deprecated workflow type.

    
    
• On success, responds with UndeprecateWorkflowTypeOutput
• On failure, responds with SdkError<UndeprecateWorkflowTypeError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tags to remove from the Amazon SWF domain.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.