Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Description

Documentation

data WriteApplicationSettingsRequest Source #

Specifies the default settings for an application.

See: newWriteApplicationSettingsRequest smart constructor.

Constructors

WriteApplicationSettingsRequest'

Fields

eventTaggingEnabled :: Maybe Bool
cloudWatchMetricsEnabled :: Maybe Bool
Specifies whether to enable application-related alarms in Amazon CloudWatch.
limits :: Maybe CampaignLimits
The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
quietTime :: Maybe QuietTime
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
campaignHook :: Maybe CampaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

Instances

Instances details

Eq WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods (==) :: WriteApplicationSettingsRequest -> WriteApplicationSettingsRequest -> Bool # (/=) :: WriteApplicationSettingsRequest -> WriteApplicationSettingsRequest -> Bool #
Read WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods readsPrec :: Int -> ReadS WriteApplicationSettingsRequest # readList :: ReadS [WriteApplicationSettingsRequest] # readPrec :: ReadPrec WriteApplicationSettingsRequest # readListPrec :: ReadPrec [WriteApplicationSettingsRequest] #
Show WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods showsPrec :: Int -> WriteApplicationSettingsRequest -> ShowS # show :: WriteApplicationSettingsRequest -> String # showList :: [WriteApplicationSettingsRequest] -> ShowS #
Generic WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Associated Types type Rep WriteApplicationSettingsRequest :: Type -> Type # Methods from :: WriteApplicationSettingsRequest -> Rep WriteApplicationSettingsRequest x # to :: Rep WriteApplicationSettingsRequest x -> WriteApplicationSettingsRequest #
NFData WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods rnf :: WriteApplicationSettingsRequest -> () #
Hashable WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods hashWithSalt :: Int -> WriteApplicationSettingsRequest -> Int # hash :: WriteApplicationSettingsRequest -> Int #
ToJSON WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest Methods toJSON :: WriteApplicationSettingsRequest -> Value # toEncoding :: WriteApplicationSettingsRequest -> Encoding # toJSONList :: [WriteApplicationSettingsRequest] -> Value # toEncodingList :: [WriteApplicationSettingsRequest] -> Encoding #
type Rep WriteApplicationSettingsRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest type Rep WriteApplicationSettingsRequest = D1 ('MetaData "WriteApplicationSettingsRequest" "Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteApplicationSettingsRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventTaggingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cloudWatchMetricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits)) :: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :: S1 ('MetaSel ('Just "campaignHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook))))))

newWriteApplicationSettingsRequest :: WriteApplicationSettingsRequest Source #

Create a value of WriteApplicationSettingsRequest 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:eventTaggingEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_eventTaggingEnabled - Undocumented member.

$sel:cloudWatchMetricsEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch.

$sel:limits:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_limits - The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

$sel:quietTime:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

$sel:campaignHook:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_campaignHook - The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

writeApplicationSettingsRequest_eventTaggingEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #

Undocumented member.

writeApplicationSettingsRequest_cloudWatchMetricsEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #

Specifies whether to enable application-related alarms in Amazon CloudWatch.

writeApplicationSettingsRequest_limits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

writeApplicationSettingsRequest_quietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime) Source #

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

writeApplicationSettingsRequest_campaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.