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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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,
}

Campaign Limits are used to limit the number of messages that can be sent to a single endpoint.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#daily ⇒ Integer

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

Returns:

  • (Integer) 


1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 1607

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

#maximum_duration ⇒ Integer

The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

Returns:

  • (Integer) 


1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 1607

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

#messages_per_second ⇒ Integer

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

Returns:

  • (Integer) 


1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 1607

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

#total ⇒ Integer

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

Returns:

  • (Integer) 


1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 1607

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