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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


1910
1911
1912
1913
1914
1915
1916
1917
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1910

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#campaign_hookTypes::CampaignHook

The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.

Returns:



1910
1911
1912
1913
1914
1915
1916
1917
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1910

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#last_modified_dateString

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

Returns:

  • (String)


1910
1911
1912
1913
1914
1915
1916
1917
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1910

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#limitsTypes::CampaignLimits

The default sending limits for campaigns in the application.



1910
1911
1912
1913
1914
1915
1916
1917
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1910

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time)
  include Aws::Structure
end

#quiet_timeTypes::QuietTime

The default quiet time for campaigns and journeys 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:



1910
1911
1912
1913
1914
1915
1916
1917
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1910

class ApplicationSettingsResource < Struct.new(
  :application_id,
  :campaign_hook,
  :last_modified_date,
  :limits,
  :quiet_time)
  include Aws::Structure
end