You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SWF::Types::StartTimerDecisionAttributes

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass StartTimerDecisionAttributes data as a hash:

{
  timer_id: "TimerId", # required
  control: "Data",
  start_to_fire_timeout: "DurationInSeconds", # required
}

Provides the details of the StartTimer decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#controlString

The data attached to the event that can be used by the decider in subsequent workflow tasks.

Returns:

  • (String)


5619
5620
5621
5622
5623
5624
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5619

class StartTimerDecisionAttributes < Struct.new(
  :timer_id,
  :control,
  :start_to_fire_timeout)
  include Aws::Structure
end

#start_to_fire_timeoutString

The duration to wait before firing the timer.

The duration is specified in seconds, an integer greater than or equal to 0.

Returns:

  • (String)


5619
5620
5621
5622
5623
5624
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5619

class StartTimerDecisionAttributes < Struct.new(
  :timer_id,
  :control,
  :start_to_fire_timeout)
  include Aws::Structure
end

#timer_idString

The unique ID of the timer.

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 contain the literal string arn.

Returns:

  • (String)


5619
5620
5621
5622
5623
5624
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5619

class StartTimerDecisionAttributes < Struct.new(
  :timer_id,
  :control,
  :start_to_fire_timeout)
  include Aws::Structure
end