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)


1544
1545
1546
1547
1548
1549
1550
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1544

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

#maximum_durationInteger

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)


1544
1545
1546
1547
1548
1549
1550
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1544

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

#messages_per_secondInteger

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

Returns:

  • (Integer)


1544
1545
1546
1547
1548
1549
1550
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1544

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)


1544
1545
1546
1547
1548
1549
1550
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1544

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