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

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,
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#dailyInteger

The maximum number of messages that the campaign can send daily.

Returns:

  • (Integer)


1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1123

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

#maximum_durationInteger

The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.

Returns:

  • (Integer)


1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1123

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

#messages_per_secondInteger

The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50

Returns:

  • (Integer)


1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1123

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

#totalInteger

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

Returns:

  • (Integer)


1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1123

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