Class: Aws::Pinpoint::Types::ApplicationSettingsResource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#campaign_hook ⇒ Types::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.

Returns:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#journey_limits ⇒ Types::ApplicationSettingsJourneyLimits

The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

Returns:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ String

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

Returns:

  • (String) 


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#limits ⇒ Types::CampaignLimits

The default sending limits for campaigns in the application.

Returns:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end

#quiet_time ⇒ Types::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.

Returns:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1609

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time,
  :journey_limits)
  SENSITIVE = []
  include Aws::Structure
end