libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.Types.CampaignLimits

Description

 
Synopsis

Documentation

data CampaignLimits Source #

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.

See: newCampaignLimits smart constructor.

Constructors

CampaignLimits' 

Fields

  • messagesPerSecond :: Maybe Int

    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.

  • daily :: Maybe Int

    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.

  • total :: Maybe Int

    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.

  • session :: Maybe Int

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

  • maximumDuration :: Maybe Int

    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.

Instances

Instances details
Eq CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Read CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Show CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Generic CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Associated Types

type Rep CampaignLimits :: Type -> Type #

NFData CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Methods

rnf :: CampaignLimits -> () #

Hashable CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

ToJSON CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

FromJSON CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

type Rep CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

type Rep CampaignLimits = D1 ('MetaData "CampaignLimits" "Amazonka.Pinpoint.Types.CampaignLimits" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignLimits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "daily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maximumDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newCampaignLimits :: CampaignLimits Source #

Create a value of CampaignLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:messagesPerSecond:CampaignLimits', campaignLimits_messagesPerSecond - 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.

$sel:daily:CampaignLimits', campaignLimits_daily - 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.

$sel:total:CampaignLimits', campaignLimits_total - 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.

$sel:session:CampaignLimits', campaignLimits_session - The maximum total number of messages that the campaign can send per user session.

$sel:maximumDuration:CampaignLimits', campaignLimits_maximumDuration - 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.

campaignLimits_messagesPerSecond :: Lens' CampaignLimits (Maybe Int) Source #

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.

campaignLimits_daily :: Lens' CampaignLimits (Maybe Int) Source #

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.

campaignLimits_total :: Lens' CampaignLimits (Maybe Int) Source #

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.

campaignLimits_session :: Lens' CampaignLimits (Maybe Int) Source #

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

campaignLimits_maximumDuration :: Lens' CampaignLimits (Maybe Int) Source #

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.