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

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

Overview

Note:

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

{
  daily: 1,
  maximum_duration: 1,
  messages_per_second: 1,
  total: 1,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dailyInteger

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)


2628
2629
2630
2631
2632
2633
2634
2635
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2628

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

#maximum_durationInteger

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)


2628
2629
2630
2631
2632
2633
2634
2635
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2628

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

#messages_per_secondInteger

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 50. The maximum value is 20,000.

Returns:

  • (Integer)


2628
2629
2630
2631
2632
2633
2634
2635
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2628

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

#totalInteger

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)


2628
2629
2630
2631
2632
2633
2634
2635
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2628

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