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

Specifies limits on the messages that a campaign can send.

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. The maximum value is 100.

Returns:

  • (Integer)


1934
1935
1936
1937
1938
1939
1940
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1934

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total)
  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)


1934
1935
1936
1937
1938
1939
1940
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1934

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

#messages_per_secondInteger

The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

Returns:

  • (Integer)


1934
1935
1936
1937
1938
1939
1940
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1934

class CampaignLimits < Struct.new(
  :daily,
  :maximum_duration,
  :messages_per_second,
  :total)
  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. The maximum value is 100.

Returns:

  • (Integer)


1934
1935
1936
1937
1938
1939
1940
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1934

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