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.ApplicationSettingsResource

Description

 
Synopsis

Documentation

data ApplicationSettingsResource Source #

Provides information about an application, including the default settings for an application.

See: newApplicationSettingsResource smart constructor.

Constructors

ApplicationSettingsResource' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time, in ISO 8601 format, when the application's settings were last modified.

  • limits :: Maybe CampaignLimits

    The default sending limits for campaigns in the application.

  • 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.

  • 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.

  • applicationId :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Instances

Instances details
Eq ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Read ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Show ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Generic ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Associated Types

type Rep ApplicationSettingsResource :: Type -> Type #

NFData ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Hashable ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

FromJSON ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

type Rep ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

type Rep ApplicationSettingsResource = D1 ('MetaData "ApplicationSettingsResource" "Amazonka.Pinpoint.Types.ApplicationSettingsResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ApplicationSettingsResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newApplicationSettingsResource Source #

Create a value of ApplicationSettingsResource 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:lastModifiedDate:ApplicationSettingsResource', applicationSettingsResource_lastModifiedDate - The date and time, in ISO 8601 format, when the application's settings were last modified.

$sel:limits:ApplicationSettingsResource', applicationSettingsResource_limits - The default sending limits for campaigns in the application.

$sel:quietTime:ApplicationSettingsResource', applicationSettingsResource_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.

$sel:campaignHook:ApplicationSettingsResource', applicationSettingsResource_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.

$sel:applicationId:ApplicationSettingsResource', applicationSettingsResource_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

applicationSettingsResource_lastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) Source #

The date and time, in ISO 8601 format, when the application's settings were last modified.

applicationSettingsResource_limits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application.

applicationSettingsResource_quietTime :: Lens' ApplicationSettingsResource (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.

applicationSettingsResource_campaignHook :: Lens' ApplicationSettingsResource (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.

applicationSettingsResource_applicationId :: Lens' ApplicationSettingsResource Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.