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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CampaignLimits as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#daily ⇒ Integer

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) —

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

#maximum_duration ⇒ Integer

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) —

    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

#messages_per_second ⇒ Integer

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) —

    The maximum number of messages that a campaign can send each second.

#total ⇒ Integer

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) —

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