Class: Aws::Pinpoint::Types::CampaignLimits

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::CampaignLimits

Defined in:

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

Overview

For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #daily ⇒ Integer

  The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

• #maximum_duration ⇒ Integer

  The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

• #messages_per_second ⇒ Integer

  The maximum number of messages that a campaign can send each second.

• #session ⇒ Integer

  The maximum total number of messages that the campaign can send per user session.

• #total ⇒ Integer

  The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

Instance Attribute Details

#daily ⇒ Integer

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

Returns:

• (Integer)

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

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total,
  :session)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_duration ⇒ Integer

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

Returns:

• (Integer)

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

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total,
  :session)
  SENSITIVE = []
  include Aws::Structure
end

#messages_per_second ⇒ Integer

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

Returns:

• (Integer)

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

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total,
  :session)
  SENSITIVE = []
  include Aws::Structure
end

#session ⇒ Integer

The maximum total number of messages that the campaign can send per user session.

Returns:

• (Integer)

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

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total,
  :session)
  SENSITIVE = []
  include Aws::Structure
end

#total ⇒ Integer

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

Returns:

• (Integer)

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

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total,
  :session)
  SENSITIVE = []
  include Aws::Structure
end