Class: Aws::Pinpoint::Types::JourneyLimits

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::JourneyLimits

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #daily_cap ⇒ Integer

  The maximum number of messages that the journey can send to a single participant during a 24-hour period.

• #endpoint_reentry_cap ⇒ Integer

  The maximum number of times that a participant can enter the journey.

• #endpoint_reentry_interval ⇒ String

  Minimum time that must pass before an endpoint can re-enter a given journey.

• #messages_per_second ⇒ Integer

  The maximum number of messages that the journey can send each second.

• #timeframe_cap ⇒ Types::JourneyTimeframeCap

  The number of messages that an endpoint can receive during the specified timeframe.

• #total_cap ⇒ Integer

  The maximum number of messages a journey can sent to a single endpoint.

Instance Attribute Details

#daily_cap ⇒ Integer

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_reentry_cap ⇒ Integer

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_reentry_interval ⇒ String

Minimum time that must pass before an endpoint can re-enter a given journey.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end

#messages_per_second ⇒ Integer

The maximum number of messages that the journey can send each second.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end

#timeframe_cap ⇒ Types::JourneyTimeframeCap

The number of messages that an endpoint can receive during the specified timeframe.

Returns:

• (Types::JourneyTimeframeCap)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end

#total_cap ⇒ Integer

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8441

class JourneyLimits < Struct.new(
  :daily_cap,
  :endpoint_reentry_cap,
  :messages_per_second,
  :endpoint_reentry_interval,
  :timeframe_cap,
  :total_cap)
  SENSITIVE = []
  include Aws::Structure
end