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

Class: Aws::Pinpoint::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Pinpoint::Client

show all

Defined in:: (unknown)

Overview

An API client for Amazon Pinpoint. To construct a client, you need to configure a :region and :credentials.

pinpoint = Aws::Pinpoint::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Pinpoint::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::Pinpoint::Client constructor
Constructs an API client.

API Operations collapse

#create_app(options = {}) ⇒ Types::CreateAppResponse
Creates an application.

.
#create_campaign(options = {}) ⇒ Types::CreateCampaignResponse
Creates a new campaign for an application or updates the settings of an existing campaign for an application.

.
#create_email_template(options = {}) ⇒ Types::CreateEmailTemplateResponse
Creates a message template for messages that are sent through the email channel.

.
#create_export_job(options = {}) ⇒ Types::CreateExportJobResponse
Creates an export job for an application.

.
#create_import_job(options = {}) ⇒ Types::CreateImportJobResponse
Creates an import job for an application.

.
#create_journey(options = {}) ⇒ Types::CreateJourneyResponse
Creates a journey for an application.

.
#create_push_template(options = {}) ⇒ Types::CreatePushTemplateResponse
Creates a message template for messages that are sent through a push notification channel.

.
#create_recommender_configuration(options = {}) ⇒ Types::CreateRecommenderConfigurationResponse
Creates an Amazon Pinpoint configuration for a recommender model.

.
#create_segment(options = {}) ⇒ Types::CreateSegmentResponse
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

.
#create_sms_template(options = {}) ⇒ Types::CreateSmsTemplateResponse
Creates a message template for messages that are sent through the SMS channel.

.
#create_voice_template(options = {}) ⇒ Types::CreateVoiceTemplateResponse
Creates a message template for messages that are sent through the voice channel.

.
#delete_adm_channel(options = {}) ⇒ Types::DeleteAdmChannelResponse
Disables the ADM channel for an application and deletes any existing settings for the channel.

.
#delete_apns_channel(options = {}) ⇒ Types::DeleteApnsChannelResponse
Disables the APNs channel for an application and deletes any existing settings for the channel.

.
#delete_apns_sandbox_channel(options = {}) ⇒ Types::DeleteApnsSandboxChannelResponse
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

.
#delete_apns_voip_channel(options = {}) ⇒ Types::DeleteApnsVoipChannelResponse
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

.
#delete_apns_voip_sandbox_channel(options = {}) ⇒ Types::DeleteApnsVoipSandboxChannelResponse
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

.
#delete_app(options = {}) ⇒ Types::DeleteAppResponse
Deletes an application.

.
#delete_baidu_channel(options = {}) ⇒ Types::DeleteBaiduChannelResponse
Disables the Baidu channel for an application and deletes any existing settings for the channel.

.
#delete_campaign(options = {}) ⇒ Types::DeleteCampaignResponse
Deletes a campaign from an application.

.
#delete_email_channel(options = {}) ⇒ Types::DeleteEmailChannelResponse
Disables the email channel for an application and deletes any existing settings for the channel.

.
#delete_email_template(options = {}) ⇒ Types::DeleteEmailTemplateResponse
Deletes a message template for messages that were sent through the email channel.

.
#delete_endpoint(options = {}) ⇒ Types::DeleteEndpointResponse
Deletes an endpoint from an application.

.
#delete_event_stream(options = {}) ⇒ Types::DeleteEventStreamResponse
Deletes the event stream for an application.

.
#delete_gcm_channel(options = {}) ⇒ Types::DeleteGcmChannelResponse
Disables the GCM channel for an application and deletes any existing settings for the channel.

.
#delete_journey(options = {}) ⇒ Types::DeleteJourneyResponse
Deletes a journey from an application.

.
#delete_push_template(options = {}) ⇒ Types::DeletePushTemplateResponse
Deletes a message template for messages that were sent through a push notification channel.

.
#delete_recommender_configuration(options = {}) ⇒ Types::DeleteRecommenderConfigurationResponse
Deletes an Amazon Pinpoint configuration for a recommender model.

.
#delete_segment(options = {}) ⇒ Types::DeleteSegmentResponse
Deletes a segment from an application.

.
#delete_sms_channel(options = {}) ⇒ Types::DeleteSmsChannelResponse
Disables the SMS channel for an application and deletes any existing settings for the channel.

.
#delete_sms_template(options = {}) ⇒ Types::DeleteSmsTemplateResponse
Deletes a message template for messages that were sent through the SMS channel.

.
#delete_user_endpoints(options = {}) ⇒ Types::DeleteUserEndpointsResponse
Deletes all the endpoints that are associated with a specific user ID.

.
#delete_voice_channel(options = {}) ⇒ Types::DeleteVoiceChannelResponse
Disables the voice channel for an application and deletes any existing settings for the channel.

.
#delete_voice_template(options = {}) ⇒ Types::DeleteVoiceTemplateResponse
Deletes a message template for messages that were sent through the voice channel.

.
#get_adm_channel(options = {}) ⇒ Types::GetAdmChannelResponse
Retrieves information about the status and settings of the ADM channel for an application.

.
#get_apns_channel(options = {}) ⇒ Types::GetApnsChannelResponse
Retrieves information about the status and settings of the APNs channel for an application.

.
#get_apns_sandbox_channel(options = {}) ⇒ Types::GetApnsSandboxChannelResponse
Retrieves information about the status and settings of the APNs sandbox channel for an application.

.
#get_apns_voip_channel(options = {}) ⇒ Types::GetApnsVoipChannelResponse
Retrieves information about the status and settings of the APNs VoIP channel for an application.

.
#get_apns_voip_sandbox_channel(options = {}) ⇒ Types::GetApnsVoipSandboxChannelResponse
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

.
#get_app(options = {}) ⇒ Types::GetAppResponse
Retrieves information about an application.

.
#get_application_date_range_kpi(options = {}) ⇒ Types::GetApplicationDateRangeKpiResponse
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

.
#get_application_settings(options = {}) ⇒ Types::GetApplicationSettingsResponse
Retrieves information about the settings for an application.

.
#get_apps(options = {}) ⇒ Types::GetAppsResponse
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

.
#get_baidu_channel(options = {}) ⇒ Types::GetBaiduChannelResponse
Retrieves information about the status and settings of the Baidu channel for an application.

.
#get_campaign(options = {}) ⇒ Types::GetCampaignResponse
Retrieves information about the status, configuration, and other settings for a campaign.

.
#get_campaign_activities(options = {}) ⇒ Types::GetCampaignActivitiesResponse
Retrieves information about all the activities for a campaign.

.
#get_campaign_date_range_kpi(options = {}) ⇒ Types::GetCampaignDateRangeKpiResponse
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

.
#get_campaign_version(options = {}) ⇒ Types::GetCampaignVersionResponse
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

.
#get_campaign_versions(options = {}) ⇒ Types::GetCampaignVersionsResponse
Retrieves information about the status, configuration, and other settings for all versions of a campaign.

.
#get_campaigns(options = {}) ⇒ Types::GetCampaignsResponse
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

.
#get_channels(options = {}) ⇒ Types::GetChannelsResponse
Retrieves information about the history and status of each channel for an application.

.
#get_email_channel(options = {}) ⇒ Types::GetEmailChannelResponse
Retrieves information about the status and settings of the email channel for an application.

.
#get_email_template(options = {}) ⇒ Types::GetEmailTemplateResponse
Retrieves the content and settings of a message template for messages that are sent through the email channel.

.
#get_endpoint(options = {}) ⇒ Types::GetEndpointResponse
Retrieves information about the settings and attributes of a specific endpoint for an application.

.
#get_event_stream(options = {}) ⇒ Types::GetEventStreamResponse
Retrieves information about the event stream settings for an application.

.
#get_export_job(options = {}) ⇒ Types::GetExportJobResponse
Retrieves information about the status and settings of a specific export job for an application.

.
#get_export_jobs(options = {}) ⇒ Types::GetExportJobsResponse
Retrieves information about the status and settings of all the export jobs for an application.

.
#get_gcm_channel(options = {}) ⇒ Types::GetGcmChannelResponse
Retrieves information about the status and settings of the GCM channel for an application.

.
#get_import_job(options = {}) ⇒ Types::GetImportJobResponse
Retrieves information about the status and settings of a specific import job for an application.

.
#get_import_jobs(options = {}) ⇒ Types::GetImportJobsResponse
Retrieves information about the status and settings of all the import jobs for an application.

.
#get_journey(options = {}) ⇒ Types::GetJourneyResponse
Retrieves information about the status, configuration, and other settings for a journey.

.
#get_journey_date_range_kpi(options = {}) ⇒ Types::GetJourneyDateRangeKpiResponse
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

.
#get_journey_execution_activity_metrics(options = {}) ⇒ Types::GetJourneyExecutionActivityMetricsResponse
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

.
#get_journey_execution_metrics(options = {}) ⇒ Types::GetJourneyExecutionMetricsResponse
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

.
#get_push_template(options = {}) ⇒ Types::GetPushTemplateResponse
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

.
#get_recommender_configuration(options = {}) ⇒ Types::GetRecommenderConfigurationResponse
Retrieves information about an Amazon Pinpoint configuration for a recommender model.

.
#get_recommender_configurations(options = {}) ⇒ Types::GetRecommenderConfigurationsResponse
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

.
#get_segment(options = {}) ⇒ Types::GetSegmentResponse
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

.
#get_segment_export_jobs(options = {}) ⇒ Types::GetSegmentExportJobsResponse
Retrieves information about the status and settings of the export jobs for a segment.

.
#get_segment_import_jobs(options = {}) ⇒ Types::GetSegmentImportJobsResponse
Retrieves information about the status and settings of the import jobs for a segment.

.
#get_segment_version(options = {}) ⇒ Types::GetSegmentVersionResponse
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

.
#get_segment_versions(options = {}) ⇒ Types::GetSegmentVersionsResponse
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

.
#get_segments(options = {}) ⇒ Types::GetSegmentsResponse
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

.
#get_sms_channel(options = {}) ⇒ Types::GetSmsChannelResponse
Retrieves information about the status and settings of the SMS channel for an application.

.
#get_sms_template(options = {}) ⇒ Types::GetSmsTemplateResponse
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

.
#get_user_endpoints(options = {}) ⇒ Types::GetUserEndpointsResponse
Retrieves information about all the endpoints that are associated with a specific user ID.

.
#get_voice_channel(options = {}) ⇒ Types::GetVoiceChannelResponse
Retrieves information about the status and settings of the voice channel for an application.

.
#get_voice_template(options = {}) ⇒ Types::GetVoiceTemplateResponse
Retrieves the content and settings of a message template for messages that are sent through the voice channel.

.
#list_journeys(options = {}) ⇒ Types::ListJourneysResponse
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

.
#list_template_versions(options = {}) ⇒ Types::ListTemplateVersionsResponse
Retrieves information about all the versions of a specific message template.

.
#list_templates(options = {}) ⇒ Types::ListTemplatesResponse
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

.
#phone_number_validate(options = {}) ⇒ Types::PhoneNumberValidateResponse
Retrieves information about a phone number.

.
#put_event_stream(options = {}) ⇒ Types::PutEventStreamResponse
Creates a new event stream for an application or updates the settings of an existing event stream for an application.

.
#put_events(options = {}) ⇒ Types::PutEventsResponse
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

.
#remove_attributes(options = {}) ⇒ Types::RemoveAttributesResponse
Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

.
#send_messages(options = {}) ⇒ Types::SendMessagesResponse
Creates and sends a direct message.

.
#send_users_messages(options = {}) ⇒ Types::SendUsersMessagesResponse
Creates and sends a message to a list of users.

.
#tag_resource(options = {}) ⇒ Struct
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

.
#untag_resource(options = {}) ⇒ Struct
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

.
#update_adm_channel(options = {}) ⇒ Types::UpdateAdmChannelResponse
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

.
#update_apns_channel(options = {}) ⇒ Types::UpdateApnsChannelResponse
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

.
#update_apns_sandbox_channel(options = {}) ⇒ Types::UpdateApnsSandboxChannelResponse
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

.
#update_apns_voip_channel(options = {}) ⇒ Types::UpdateApnsVoipChannelResponse
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

.
#update_apns_voip_sandbox_channel(options = {}) ⇒ Types::UpdateApnsVoipSandboxChannelResponse
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

.
#update_application_settings(options = {}) ⇒ Types::UpdateApplicationSettingsResponse
Updates the settings for an application.

.
#update_baidu_channel(options = {}) ⇒ Types::UpdateBaiduChannelResponse
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

.
#update_campaign(options = {}) ⇒ Types::UpdateCampaignResponse
Updates the configuration and other settings for a campaign.

.
#update_email_channel(options = {}) ⇒ Types::UpdateEmailChannelResponse
Enables the email channel for an application or updates the status and settings of the email channel for an application.

.
#update_email_template(options = {}) ⇒ Types::UpdateEmailTemplateResponse
Updates an existing message template for messages that are sent through the email channel.

.
#update_endpoint(options = {}) ⇒ Types::UpdateEndpointResponse
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.
#update_endpoints_batch(options = {}) ⇒ Types::UpdateEndpointsBatchResponse
Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application.
#update_gcm_channel(options = {}) ⇒ Types::UpdateGcmChannelResponse
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

.
#update_journey(options = {}) ⇒ Types::UpdateJourneyResponse
Updates the configuration and other settings for a journey.

.
#update_journey_state(options = {}) ⇒ Types::UpdateJourneyStateResponse
Cancels (stops) an active journey.

.
#update_push_template(options = {}) ⇒ Types::UpdatePushTemplateResponse
Updates an existing message template for messages that are sent through a push notification channel.

.
#update_recommender_configuration(options = {}) ⇒ Types::UpdateRecommenderConfigurationResponse
Updates an Amazon Pinpoint configuration for a recommender model.

.
#update_segment(options = {}) ⇒ Types::UpdateSegmentResponse
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

.
#update_sms_channel(options = {}) ⇒ Types::UpdateSmsChannelResponse
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

.
#update_sms_template(options = {}) ⇒ Types::UpdateSmsTemplateResponse
Updates an existing message template for messages that are sent through the SMS channel.

.
#update_template_active_version(options = {}) ⇒ Types::UpdateTemplateActiveVersionResponse
Changes the status of a specific version of a message template to active.

.
#update_voice_channel(options = {}) ⇒ Types::UpdateVoiceChannelResponse
Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

.
#update_voice_template(options = {}) ⇒ Types::UpdateVoiceTemplateResponse
Updates an existing message template for messages that are sent through the voice channel.

.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::Pinpoint::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Aws::Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Aws::Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Aws::Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Aws::Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Aws::Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Aws::Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Aws::Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Aws::Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Aws::Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Aws::Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Aws::Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Aws::Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Aws::Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Aws::Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Aws::Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Aws::Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Aws::Plugins::ParamValidator for more details.

Instance Method Details

#create_app(options = {}) ⇒ `Types::CreateAppResponse`

Creates an application.

Examples:

Request syntax with placeholder values


resp = client.create_app({
  create_application_request: { # required
    name: "__string", # required
    tags: {
      "__string" => "__string",
    },
  },
})

Response structure


resp.application_response.arn #=> String
resp.application_response.id #=> String
resp.application_response.name #=> String
resp.application_response.tags #=> Hash
resp.application_response.tags["__string"] #=> String

Options Hash (options):

:create_application_request (required, Types::CreateApplicationRequest) —
Specifies the display name of an application and the tags to associate with the application.

Returns:

(Types::CreateAppResponse) —
Returns a response object which responds to the following methods:
- #application_response => Types::ApplicationResponse

See Also:

AWS API Documentation

#create_campaign(options = {}) ⇒ `Types::CreateCampaignResponse`

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Examples:

Request syntax with placeholder values


resp = client.create_campaign({
  application_id: "__string", # required
  write_campaign_request: { # required
    additional_treatments: [
      {
        custom_delivery_configuration: {
          delivery_uri: "__string", # required
          endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
        },
        message_configuration: {
          adm_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          apns_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          baidu_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          custom_message: {
            data: "__string",
          },
          default_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          email_message: {
            body: "__string",
            from_address: "__string",
            html_body: "__string",
            title: "__string",
          },
          gcm_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          sms_message: {
            body: "__string",
            message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
            sender_id: "__string",
          },
        },
        schedule: {
          end_time: "__string",
          event_filter: {
            dimensions: { # required
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              event_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
            },
            filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
          },
          frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
          is_local_time: false,
          quiet_time: {
            end: "__string",
            start: "__string",
          },
          start_time: "__string", # required
          timezone: "__string",
        },
        size_percent: 1, # required
        template_configuration: {
          email_template: {
            name: "__string",
            version: "__string",
          },
          push_template: {
            name: "__string",
            version: "__string",
          },
          sms_template: {
            name: "__string",
            version: "__string",
          },
          voice_template: {
            name: "__string",
            version: "__string",
          },
        },
        treatment_description: "__string",
        treatment_name: "__string",
      },
    ],
    custom_delivery_configuration: {
      delivery_uri: "__string", # required
      endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    },
    description: "__string",
    holdout_percent: 1,
    hook: {
      lambda_function_name: "__string",
      mode: "DELIVERY", # accepts DELIVERY, FILTER
      web_url: "__string",
    },
    is_paused: false,
    limits: {
      daily: 1,
      maximum_duration: 1,
      messages_per_second: 1,
      total: 1,
    },
    message_configuration: {
      adm_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      apns_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      baidu_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      custom_message: {
        data: "__string",
      },
      default_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      email_message: {
        body: "__string",
        from_address: "__string",
        html_body: "__string",
        title: "__string",
      },
      gcm_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      sms_message: {
        body: "__string",
        message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
        sender_id: "__string",
      },
    },
    name: "__string",
    schedule: {
      end_time: "__string",
      event_filter: {
        dimensions: { # required
          attributes: {
            "__string" => {
              attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
              values: ["__string"], # required
            },
          },
          event_type: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          metrics: {
            "__string" => {
              comparison_operator: "__string", # required
              value: 1.0, # required
            },
          },
        },
        filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
      },
      frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
      is_local_time: false,
      quiet_time: {
        end: "__string",
        start: "__string",
      },
      start_time: "__string", # required
      timezone: "__string",
    },
    segment_id: "__string",
    segment_version: 1,
    tags: {
      "__string" => "__string",
    },
    template_configuration: {
      email_template: {
        name: "__string",
        version: "__string",
      },
      push_template: {
        name: "__string",
        version: "__string",
      },
      sms_template: {
        name: "__string",
        version: "__string",
      },
      voice_template: {
        name: "__string",
        version: "__string",
      },
    },
    treatment_description: "__string",
    treatment_name: "__string",
  },
})

Response structure


resp.campaign_response.additional_treatments #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.campaign_response.additional_treatments[0].id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.from_address #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.html_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaign_response.additional_treatments[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> true/false
resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
resp.campaign_response.additional_treatments[0].size_percent #=> Integer
resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> true/false
resp.campaign_response.last_modified_date #=> String
resp.campaign_response.limits.daily #=> Integer
resp.campaign_response.limits.maximum_duration #=> Integer
resp.campaign_response.limits.messages_per_second #=> Integer
resp.campaign_response.limits.total #=> Integer
resp.campaign_response.message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.adm_message.body #=> String
resp.campaign_response.message_configuration.adm_message.image_icon_url #=> String
resp.campaign_response.message_configuration.adm_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.adm_message.image_url #=> String
resp.campaign_response.message_configuration.adm_message.json_body #=> String
resp.campaign_response.message_configuration.adm_message.media_url #=> String
resp.campaign_response.message_configuration.adm_message.raw_content #=> String
resp.campaign_response.message_configuration.adm_message.silent_push #=> true/false
resp.campaign_response.message_configuration.adm_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.adm_message.title #=> String
resp.campaign_response.message_configuration.adm_message.url #=> String
resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.apns_message.body #=> String
resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
resp.campaign_response.message_configuration.apns_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.apns_message.image_url #=> String
resp.campaign_response.message_configuration.apns_message.json_body #=> String
resp.campaign_response.message_configuration.apns_message.media_url #=> String
resp.campaign_response.message_configuration.apns_message.raw_content #=> String
resp.campaign_response.message_configuration.apns_message.silent_push #=> true/false
resp.campaign_response.message_configuration.apns_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.apns_message.title #=> String
resp.campaign_response.message_configuration.apns_message.url #=> String
resp.campaign_response.message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.baidu_message.body #=> String
resp.campaign_response.message_configuration.baidu_message.image_icon_url #=> String
resp.campaign_response.message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.baidu_message.image_url #=> String
resp.campaign_response.message_configuration.baidu_message.json_body #=> String
resp.campaign_response.message_configuration.baidu_message.media_url #=> String
resp.campaign_response.message_configuration.baidu_message.raw_content #=> String
resp.campaign_response.message_configuration.baidu_message.silent_push #=> true/false
resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.baidu_message.title #=> String
resp.campaign_response.message_configuration.baidu_message.url #=> String
resp.campaign_response.message_configuration.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> true/false
resp.campaign_response.message_configuration.default_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.default_message.title #=> String
resp.campaign_response.message_configuration.default_message.url #=> String
resp.campaign_response.message_configuration.email_message.body #=> String
resp.campaign_response.message_configuration.email_message.from_address #=> String
resp.campaign_response.message_configuration.email_message.html_body #=> String
resp.campaign_response.message_configuration.email_message.title #=> String
resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.gcm_message.body #=> String
resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
resp.campaign_response.message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.gcm_message.image_url #=> String
resp.campaign_response.message_configuration.gcm_message.json_body #=> String
resp.campaign_response.message_configuration.gcm_message.media_url #=> String
resp.campaign_response.message_configuration.gcm_message.raw_content #=> String
resp.campaign_response.message_configuration.gcm_message.silent_push #=> true/false
resp.campaign_response.message_configuration.gcm_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.gcm_message.title #=> String
resp.campaign_response.message_configuration.gcm_message.url #=> String
resp.campaign_response.message_configuration.sms_message.body #=> String
resp.campaign_response.message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.name #=> String
resp.campaign_response.schedule.end_time #=> String
resp.campaign_response.schedule.event_filter.dimensions.attributes #=> Hash
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaign_response.schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaign_response.schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaign_response.schedule.event_filter.dimensions.metrics #=> Hash
resp.campaign_response.schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaign_response.schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaign_response.schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaign_response.schedule.is_local_time #=> true/false
resp.campaign_response.schedule.quiet_time.end #=> String
resp.campaign_response.schedule.quiet_time.start #=> String
resp.campaign_response.schedule.start_time #=> String
resp.campaign_response.schedule.timezone #=> String
resp.campaign_response.segment_id #=> String
resp.campaign_response.segment_version #=> Integer
resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer

Options Hash (options):

:application_id (required, String)
:write_campaign_request (required, Types::WriteCampaignRequest) —
Specifies the configuration and other settings for a campaign.

Returns:

(Types::CreateCampaignResponse) —
Returns a response object which responds to the following methods:
- #campaign_response => Types::CampaignResponse

See Also:

AWS API Documentation

#create_email_template(options = {}) ⇒ `Types::CreateEmailTemplateResponse`

Creates a message template for messages that are sent through the email channel.

Examples:

Request syntax with placeholder values


resp = client.create_email_template({
  email_template_request: { # required
    default_substitutions: "__string",
    html_part: "__string",
    recommender_id: "__string",
    subject: "__string",
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
    text_part: "__string",
  },
  template_name: "__string", # required
})

Response structure


resp.create_template_message_body.arn #=> String
resp.create_template_message_body.message #=> String
resp.create_template_message_body.request_id #=> String

Options Hash (options):

:email_template_request (required, Types::EmailTemplateRequest) —
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
:template_name (required, String)

Returns:

(Types::CreateEmailTemplateResponse) —
Returns a response object which responds to the following methods:
- #create_template_message_body => Types::CreateTemplateMessageBody

See Also:

AWS API Documentation

#create_export_job(options = {}) ⇒ `Types::CreateExportJobResponse`

Creates an export job for an application.

Examples:

Request syntax with placeholder values


resp = client.create_export_job({
  application_id: "__string", # required
  export_job_request: { # required
    role_arn: "__string", # required
    s3_url_prefix: "__string", # required
    segment_id: "__string",
    segment_version: 1,
  },
})

Response structure


resp.export_job_response.application_id #=> String
resp.export_job_response.completed_pieces #=> Integer
resp.export_job_response.completion_date #=> String
resp.export_job_response.creation_date #=> String
resp.export_job_response.definition.role_arn #=> String
resp.export_job_response.definition.s3_url_prefix #=> String
resp.export_job_response.definition.segment_id #=> String
resp.export_job_response.definition.segment_version #=> Integer
resp.export_job_response.failed_pieces #=> Integer
resp.export_job_response.failures #=> Array
resp.export_job_response.failures[0] #=> String
resp.export_job_response.id #=> String
resp.export_job_response.job_status #=> String, one of "CREATED", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.export_job_response.total_failures #=> Integer
resp.export_job_response.total_pieces #=> Integer
resp.export_job_response.total_processed #=> Integer
resp.export_job_response.type #=> String

Options Hash (options):

:application_id (required, String)
:export_job_request (required, Types::ExportJobRequest) —
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

(Types::CreateExportJobResponse) —
Returns a response object which responds to the following methods:
- #export_job_response => Types::ExportJobResponse

See Also:

AWS API Documentation

#create_import_job(options = {}) ⇒ `Types::CreateImportJobResponse`

Creates an import job for an application.

Examples:

Request syntax with placeholder values


resp = client.create_import_job({
  application_id: "__string", # required
  import_job_request: { # required
    define_segment: false,
    external_id: "__string",
    format: "CSV", # required, accepts CSV, JSON
    register_endpoints: false,
    role_arn: "__string", # required
    s3_url: "__string", # required
    segment_id: "__string",
    segment_name: "__string",
  },
})

Response structure


resp.import_job_response.application_id #=> String
resp.import_job_response.completed_pieces #=> Integer
resp.import_job_response.completion_date #=> String
resp.import_job_response.creation_date #=> String
resp.import_job_response.definition.define_segment #=> true/false
resp.import_job_response.definition.external_id #=> String
resp.import_job_response.definition.format #=> String, one of "CSV", "JSON"
resp.import_job_response.definition.register_endpoints #=> true/false
resp.import_job_response.definition.role_arn #=> String
resp.import_job_response.definition.s3_url #=> String
resp.import_job_response.definition.segment_id #=> String
resp.import_job_response.definition.segment_name #=> String
resp.import_job_response.failed_pieces #=> Integer
resp.import_job_response.failures #=> Array
resp.import_job_response.failures[0] #=> String
resp.import_job_response.id #=> String
resp.import_job_response.job_status #=> String, one of "CREATED", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.import_job_response.total_failures #=> Integer
resp.import_job_response.total_pieces #=> Integer
resp.import_job_response.total_processed #=> Integer
resp.import_job_response.type #=> String

Options Hash (options):

:application_id (required, String)
:import_job_request (required, Types::ImportJobRequest) —
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

(Types::CreateImportJobResponse) —
Returns a response object which responds to the following methods:
- #import_job_response => Types::ImportJobResponse

See Also:

AWS API Documentation

#create_journey(options = {}) ⇒ `Types::CreateJourneyResponse`

Creates a journey for an application.

Examples:

Request syntax with placeholder values


resp = client.create_journey({
  application_id: "__string", # required
  write_journey_request: { # required
    activities: {
      "__string" => {
        custom: {
          delivery_uri: "__string",
          endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
          message_config: {
            data: "__string",
          },
          next_activity: "__string",
          template_name: "__string",
          template_version: "__string",
        },
        conditional_split: {
          condition: {
            conditions: [
              {
                event_condition: {
                  dimensions: {
                    attributes: {
                      "__string" => {
                        attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                        values: ["__string"], # required
                      },
                    },
                    event_type: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    metrics: {
                      "__string" => {
                        comparison_operator: "__string", # required
                        value: 1.0, # required
                      },
                    },
                  },
                  message_activity: "__string",
                },
                segment_condition: {
                  segment_id: "__string", # required
                },
                segment_dimensions: {
                  attributes: {
                    "__string" => {
                      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                  behavior: {
                    recency: {
                      duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                      recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
                    },
                  },
                  demographic: {
                    app_version: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    channel: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    device_type: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    make: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    model: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    platform: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                  location: {
                    country: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    gps_point: {
                      coordinates: { # required
                        latitude: 1.0, # required
                        longitude: 1.0, # required
                      },
                      range_in_kilometers: 1.0,
                    },
                  },
                  metrics: {
                    "__string" => {
                      comparison_operator: "__string", # required
                      value: 1.0, # required
                    },
                  },
                  user_attributes: {
                    "__string" => {
                      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                },
              },
            ],
            operator: "ALL", # accepts ALL, ANY
          },
          evaluation_wait_time: {
            wait_for: "__string",
            wait_until: "__string",
          },
          false_activity: "__string",
          true_activity: "__string",
        },
        description: "__string",
        email: {
          message_config: {
            from_address: "__string",
          },
          next_activity: "__string",
          template_name: "__string",
          template_version: "__string",
        },
        holdout: {
          next_activity: "__string",
          percentage: 1, # required
        },
        multi_condition: {
          branches: [
            {
              condition: {
                event_condition: {
                  dimensions: {
                    attributes: {
                      "__string" => {
                        attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                        values: ["__string"], # required
                      },
                    },
                    event_type: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    metrics: {
                      "__string" => {
                        comparison_operator: "__string", # required
                        value: 1.0, # required
                      },
                    },
                  },
                  message_activity: "__string",
                },
                segment_condition: {
                  segment_id: "__string", # required
                },
                segment_dimensions: {
                  attributes: {
                    "__string" => {
                      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                  behavior: {
                    recency: {
                      duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                      recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
                    },
                  },
                  demographic: {
                    app_version: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    channel: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    device_type: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    make: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    model: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    platform: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                  location: {
                    country: {
                      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                    gps_point: {
                      coordinates: { # required
                        latitude: 1.0, # required
                        longitude: 1.0, # required
                      },
                      range_in_kilometers: 1.0,
                    },
                  },
                  metrics: {
                    "__string" => {
                      comparison_operator: "__string", # required
                      value: 1.0, # required
                    },
                  },
                  user_attributes: {
                    "__string" => {
                      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                      values: ["__string"], # required
                    },
                  },
                },
              },
              next_activity: "__string",
            },
          ],
          default_activity: "__string",
          evaluation_wait_time: {
            wait_for: "__string",
            wait_until: "__string",
          },
        },
        push: {
          message_config: {
            time_to_live: "__string",
          },
          next_activity: "__string",
          template_name: "__string",
          template_version: "__string",
        },
        random_split: {
          branches: [
            {
              next_activity: "__string",
              percentage: 1,
            },
          ],
        },
        sms: {
          message_config: {
            message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
            sender_id: "__string",
          },
          next_activity: "__string",
          template_name: "__string",
          template_version: "__string",
        },
        wait: {
          next_activity: "__string",
          wait_time: {
            wait_for: "__string",
            wait_until: "__string",
          },
        },
      },
    },
    creation_date: "__string",
    last_modified_date: "__string",
    limits: {
      daily_cap: 1,
      endpoint_reentry_cap: 1,
      messages_per_second: 1,
    },
    local_time: false,
    name: "__string", # required
    quiet_time: {
      end: "__string",
      start: "__string",
    },
    refresh_frequency: "__string",
    schedule: {
      end_time: Time.now,
      start_time: Time.now,
      timezone: "__string",
    },
    start_activity: "__string",
    start_condition: {
      description: "__string",
      event_start_condition: {
        event_filter: {
          dimensions: { # required
            attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
            event_type: {
              dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
              values: ["__string"], # required
            },
            metrics: {
              "__string" => {
                comparison_operator: "__string", # required
                value: 1.0, # required
              },
            },
          },
          filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
        },
        segment_id: "__string",
      },
      segment_start_condition: {
        segment_id: "__string", # required
      },
    },
    state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
  },
})

Response structure


resp.journey_response.activities #=> Hash
resp.journey_response.activities["__string"].custom.delivery_uri #=> String
resp.journey_response.activities["__string"].custom.endpoint_types #=> Array
resp.journey_response.activities["__string"].custom.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.journey_response.activities["__string"].custom.message_config.data #=> String
resp.journey_response.activities["__string"].custom.next_activity #=> String
resp.journey_response.activities["__string"].custom.template_name #=> String
resp.journey_response.activities["__string"].custom.template_version #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.message_activity #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_condition.segment_id #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.operator #=> String, one of "ALL", "ANY"
resp.journey_response.activities["__string"].conditional_split.evaluation_wait_time.wait_for #=> String
resp.journey_response.activities["__string"].conditional_split.evaluation_wait_time.wait_until #=> String
resp.journey_response.activities["__string"].conditional_split.false_activity #=> String
resp.journey_response.activities["__string"].conditional_split.true_activity #=> String
resp.journey_response.activities["__string"].description #=> String
resp.journey_response.activities["__string"].email.message_config.from_address #=> String
resp.journey_response.activities["__string"].email.next_activity #=> String
resp.journey_response.activities["__string"].email.template_name #=> String
resp.journey_response.activities["__string"].email.template_version #=> String
resp.journey_response.activities["__string"].holdout.next_activity #=> String
resp.journey_response.activities["__string"].holdout.percentage #=> Integer
resp.journey_response.activities["__string"].multi_condition.branches #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.message_activity #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_condition.segment_id #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].next_activity #=> String
resp.journey_response.activities["__string"].multi_condition.default_activity #=> String
resp.journey_response.activities["__string"].multi_condition.evaluation_wait_time.wait_for #=> String
resp.journey_response.activities["__string"].multi_condition.evaluation_wait_time.wait_until #=> String
resp.journey_response.activities["__string"].push.message_config.time_to_live #=> String
resp.journey_response.activities["__string"].push.next_activity #=> String
resp.journey_response.activities["__string"].push.template_name #=> String
resp.journey_response.activities["__string"].push.template_version #=> String
resp.journey_response.activities["__string"].random_split.branches #=> Array
resp.journey_response.activities["__string"].random_split.branches[0].next_activity #=> String
resp.journey_response.activities["__string"].random_split.branches[0].percentage #=> Integer
resp.journey_response.activities["__string"].sms.message_config.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.journey_response.activities["__string"].sms.message_config.sender_id #=> String
resp.journey_response.activities["__string"].sms.next_activity #=> String
resp.journey_response.activities["__string"].sms.template_name #=> String
resp.journey_response.activities["__string"].sms.template_version #=> String
resp.journey_response.activities["__string"].wait.next_activity #=> String
resp.journey_response.activities["__string"].wait.wait_time.wait_for #=> String
resp.journey_response.activities["__string"].wait.wait_time.wait_until #=> String
resp.journey_response.application_id #=> String
resp.journey_response.creation_date #=> String
resp.journey_response.id #=> String
resp.journey_response.last_modified_date #=> String
resp.journey_response.limits.daily_cap #=> Integer
resp.journey_response.limits.endpoint_reentry_cap #=> Integer
resp.journey_response.limits.messages_per_second #=> Integer
resp.journey_response.local_time #=> true/false
resp.journey_response.name #=> String
resp.journey_response.quiet_time.end #=> String
resp.journey_response.quiet_time.start #=> String
resp.journey_response.refresh_frequency #=> String
resp.journey_response.schedule.end_time #=> Time
resp.journey_response.schedule.start_time #=> Time
resp.journey_response.schedule.timezone #=> String
resp.journey_response.start_activity #=> String
resp.journey_response.start_condition.description #=> String
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.attributes #=> Hash
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].values #=> Array
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.event_type.values #=> Array
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.event_type.values[0] #=> String
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.metrics #=> Hash
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.start_condition.event_start_condition.event_filter.dimensions.metrics["__string"].value #=> Float
resp.journey_response.start_condition.event_start_condition.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.journey_response.start_condition.event_start_condition.segment_id #=> String
resp.journey_response.start_condition.segment_start_condition.segment_id #=> String
resp.journey_response.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED"
resp.journey_response.tags #=> Hash
resp.journey_response.tags["__string"] #=> String

Options Hash (options):

:application_id (required, String)
:write_journey_request (required, Types::WriteJourneyRequest) —
Specifies the configuration and other settings for a journey.

Returns:

(Types::CreateJourneyResponse) —
Returns a response object which responds to the following methods:
- #journey_response => Types::JourneyResponse

See Also:

AWS API Documentation

#create_push_template(options = {}) ⇒ `Types::CreatePushTemplateResponse`

Creates a message template for messages that are sent through a push notification channel.

Examples:

Request syntax with placeholder values


resp = client.create_push_template({
  push_notification_template_request: { # required
    adm: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      body: "__string",
      image_icon_url: "__string",
      image_url: "__string",
      raw_content: "__string",
      small_image_icon_url: "__string",
      sound: "__string",
      title: "__string",
      url: "__string",
    },
    apns: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      body: "__string",
      media_url: "__string",
      raw_content: "__string",
      sound: "__string",
      title: "__string",
      url: "__string",
    },
    baidu: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      body: "__string",
      image_icon_url: "__string",
      image_url: "__string",
      raw_content: "__string",
      small_image_icon_url: "__string",
      sound: "__string",
      title: "__string",
      url: "__string",
    },
    default: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      body: "__string",
      sound: "__string",
      title: "__string",
      url: "__string",
    },
    default_substitutions: "__string",
    gcm: {
      action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
      body: "__string",
      image_icon_url: "__string",
      image_url: "__string",
      raw_content: "__string",
      small_image_icon_url: "__string",
      sound: "__string",
      title: "__string",
      url: "__string",
    },
    recommender_id: "__string",
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
  },
  template_name: "__string", # required
})

Response structure


resp.create_template_message_body.arn #=> String
resp.create_template_message_body.message #=> String
resp.create_template_message_body.request_id #=> String

Options Hash (options):

:push_notification_template_request (required, Types::PushNotificationTemplateRequest) —
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
:template_name (required, String)

Returns:

(Types::CreatePushTemplateResponse) —
Returns a response object which responds to the following methods:
- #create_template_message_body => Types::CreateTemplateMessageBody

See Also:

AWS API Documentation

#create_recommender_configuration(options = {}) ⇒ `Types::CreateRecommenderConfigurationResponse`

Creates an Amazon Pinpoint configuration for a recommender model.

Examples:

Request syntax with placeholder values


resp = client.create_recommender_configuration({
  create_recommender_configuration: { # required
    attributes: {
      "__string" => "__string",
    },
    description: "__string",
    name: "__string",
    recommendation_provider_id_type: "__string",
    recommendation_provider_role_arn: "__string", # required
    recommendation_provider_uri: "__string", # required
    recommendation_transformer_uri: "__string",
    recommendations_display_name: "__string",
    recommendations_per_message: 1,
  },
})

Response structure


resp.recommender_configuration_response.attributes #=> Hash
resp.recommender_configuration_response.attributes["__string"] #=> String
resp.recommender_configuration_response.creation_date #=> String
resp.recommender_configuration_response.description #=> String
resp.recommender_configuration_response.id #=> String
resp.recommender_configuration_response.last_modified_date #=> String
resp.recommender_configuration_response.name #=> String
resp.recommender_configuration_response.recommendation_provider_id_type #=> String
resp.recommender_configuration_response.recommendation_provider_role_arn #=> String
resp.recommender_configuration_response.recommendation_provider_uri #=> String
resp.recommender_configuration_response.recommendation_transformer_uri #=> String
resp.recommender_configuration_response.recommendations_display_name #=> String
resp.recommender_configuration_response.recommendations_per_message #=> Integer

Options Hash (options):

:create_recommender_configuration (required, Types::CreateRecommenderConfiguration) —
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Returns:

(Types::CreateRecommenderConfigurationResponse) —
Returns a response object which responds to the following methods:
- #recommender_configuration_response => Types::RecommenderConfigurationResponse

See Also:

AWS API Documentation

#create_segment(options = {}) ⇒ `Types::CreateSegmentResponse`

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Examples:

Request syntax with placeholder values


resp = client.create_segment({
  application_id: "__string", # required
  write_segment_request: { # required
    dimensions: {
      attributes: {
        "__string" => {
          attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
      },
      behavior: {
        recency: {
          duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
          recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
        },
      },
      demographic: {
        app_version: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        channel: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        device_type: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        make: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        model: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        platform: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
      },
      location: {
        country: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        gps_point: {
          coordinates: { # required
            latitude: 1.0, # required
            longitude: 1.0, # required
          },
          range_in_kilometers: 1.0,
        },
      },
      metrics: {
        "__string" => {
          comparison_operator: "__string", # required
          value: 1.0, # required
        },
      },
      user_attributes: {
        "__string" => {
          attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
      },
    },
    name: "__string",
    segment_groups: {
      groups: [
        {
          dimensions: [
            {
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              behavior: {
                recency: {
                  duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                  recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
                },
              },
              demographic: {
                app_version: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                channel: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                device_type: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                make: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                model: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                platform: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              location: {
                country: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                gps_point: {
                  coordinates: { # required
                    latitude: 1.0, # required
                    longitude: 1.0, # required
                  },
                  range_in_kilometers: 1.0,
                },
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
              user_attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
            },
          ],
          source_segments: [
            {
              id: "__string", # required
              version: 1,
            },
          ],
          source_type: "ALL", # accepts ALL, ANY, NONE
          type: "ALL", # accepts ALL, ANY, NONE
        },
      ],
      include: "ALL", # accepts ALL, ANY, NONE
    },
    tags: {
      "__string" => "__string",
    },
  },
})

Response structure


resp.segment_response.application_id #=> String
resp.segment_response.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.attributes["__string"].values #=> Array
resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.app_version.values #=> Array
resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
resp.segment_response.dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.channel.values #=> Array
resp.segment_response.dimensions.demographic.channel.values[0] #=> String
resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.device_type.values #=> Array
resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.make.values #=> Array
resp.segment_response.dimensions.demographic.make.values[0] #=> String
resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.model.values #=> Array
resp.segment_response.dimensions.demographic.model.values[0] #=> String
resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.demographic.platform.values #=> Array
resp.segment_response.dimensions.demographic.platform.values[0] #=> String
resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.location.country.values #=> Array
resp.segment_response.dimensions.location.country.values[0] #=> String
resp.segment_response.dimensions.location.gps_point.coordinates.latitude #=> Float
resp.segment_response.dimensions.location.gps_point.coordinates.longitude #=> Float
resp.segment_response.dimensions.location.gps_point.range_in_kilometers #=> Float
resp.segment_response.dimensions.metrics #=> Hash
resp.segment_response.dimensions.metrics["__string"].comparison_operator #=> String
resp.segment_response.dimensions.metrics["__string"].value #=> Float
resp.segment_response.dimensions.user_attributes #=> Hash
resp.segment_response.dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.dimensions.user_attributes["__string"].values #=> Array
resp.segment_response.dimensions.user_attributes["__string"].values[0] #=> String
resp.segment_response.id #=> String
resp.segment_response.import_definition.channel_counts #=> Hash
resp.segment_response.import_definition.channel_counts["__string"] #=> Integer
resp.segment_response.import_definition.external_id #=> String
resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
resp.segment_response.import_definition.role_arn #=> String
resp.segment_response.import_definition.s3_url #=> String
resp.segment_response.import_definition.size #=> Integer
resp.segment_response.last_modified_date #=> String
resp.segment_response.name #=> String
resp.segment_response.segment_groups.groups #=> Array
resp.segment_response.segment_groups.groups[0].dimensions #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].attributes #=> Hash
resp.segment_response.segment_groups.groups[0].dimensions[0].attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segment_response.segment_groups.groups[0].dimensions[0].behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.app_version.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.app_version.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.channel.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.channel.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.device_type.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.device_type.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.make.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.make.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.model.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.model.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.platform.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].demographic.platform.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].location.country.values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].location.country.values[0] #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.latitude #=> Float
resp.segment_response.segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.longitude #=> Float
resp.segment_response.segment_groups.groups[0].dimensions[0].location.gps_point.range_in_kilometers #=> Float
resp.segment_response.segment_groups.groups[0].dimensions[0].metrics #=> Hash
resp.segment_response.segment_groups.groups[0].dimensions[0].metrics["__string"].comparison_operator #=> String
resp.segment_response.segment_groups.groups[0].dimensions[0].metrics["__string"].value #=> Float
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes #=> Hash
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Options Hash (options):

:application_id (required, String)
:write_segment_request (required, Types::WriteSegmentRequest) —
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

Returns:

(Types::CreateSegmentResponse) —
Returns a response object which responds to the following methods:
- #segment_response => Types::SegmentResponse

See Also:

AWS API Documentation

#create_sms_template(options = {}) ⇒ `Types::CreateSmsTemplateResponse`

Creates a message template for messages that are sent through the SMS channel.

Examples:

Request syntax with placeholder values


resp = client.create_sms_template({
  sms_template_request: { # required
    body: "__string",
    default_substitutions: "__string",
    recommender_id: "__string",
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
  },
  template_name: "__string", # required
})

Response structure


resp.create_template_message_body.arn #=> String
resp.create_template_message_body.message #=> String
resp.create_template_message_body.request_id #=> String

Options Hash (options):

:sms_template_request (required, Types::SMSTemplateRequest) —
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
:template_name (required, String)

Returns:

(Types::CreateSmsTemplateResponse) —
Returns a response object which responds to the following methods:
- #create_template_message_body => Types::CreateTemplateMessageBody

See Also:

AWS API Documentation

#create_voice_template(options = {}) ⇒ `Types::CreateVoiceTemplateResponse`

Creates a message template for messages that are sent through the voice channel.

Examples:

Request syntax with placeholder values


resp = client.create_voice_template({
  template_name: "__string", # required
  voice_template_request: { # required
    body: "__string",
    default_substitutions: "__string",
    language_code: "__string",
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
    voice_id: "__string",
  },
})

Response structure


resp.create_template_message_body.arn #=> String
resp.create_template_message_body.message #=> String
resp.create_template_message_body.request_id #=> String

Options Hash (options):

:template_name (required, String)
:voice_template_request (required, Types::VoiceTemplateRequest) —
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Returns:

(Types::CreateVoiceTemplateResponse) —
Returns a response object which responds to the following methods:
- #create_template_message_body => Types::CreateTemplateMessageBody

See Also:

AWS API Documentation

#delete_adm_channel(options = {}) ⇒ `Types::DeleteAdmChannelResponse`

Disables the ADM channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_adm_channel({
  application_id: "__string", # required
})

Response structure


resp.adm_channel_response.application_id #=> String
resp.adm_channel_response.creation_date #=> String
resp.adm_channel_response.enabled #=> true/false
resp.adm_channel_response.has_credential #=> true/false
resp.adm_channel_response.id #=> String
resp.adm_channel_response.is_archived #=> true/false
resp.adm_channel_response.last_modified_by #=> String
resp.adm_channel_response.last_modified_date #=> String
resp.adm_channel_response.platform #=> String
resp.adm_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteAdmChannelResponse) —
Returns a response object which responds to the following methods:
- #adm_channel_response => Types::ADMChannelResponse

See Also:

AWS API Documentation

#delete_apns_channel(options = {}) ⇒ `Types::DeleteApnsChannelResponse`

Disables the APNs channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_apns_channel({
  application_id: "__string", # required
})

Response structure


resp.apns_channel_response.application_id #=> String
resp.apns_channel_response.creation_date #=> String
resp.apns_channel_response.default_authentication_method #=> String
resp.apns_channel_response.enabled #=> true/false
resp.apns_channel_response.has_credential #=> true/false
resp.apns_channel_response.has_token_key #=> true/false
resp.apns_channel_response.id #=> String
resp.apns_channel_response.is_archived #=> true/false
resp.apns_channel_response.last_modified_by #=> String
resp.apns_channel_response.last_modified_date #=> String
resp.apns_channel_response.platform #=> String
resp.apns_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteApnsChannelResponse) —
Returns a response object which responds to the following methods:
- #apns_channel_response => Types::APNSChannelResponse

See Also:

AWS API Documentation

#delete_apns_sandbox_channel(options = {}) ⇒ `Types::DeleteApnsSandboxChannelResponse`

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_apns_sandbox_channel({
  application_id: "__string", # required
})

Response structure


resp.apns_sandbox_channel_response.application_id #=> String
resp.apns_sandbox_channel_response.creation_date #=> String
resp.apns_sandbox_channel_response.default_authentication_method #=> String
resp.apns_sandbox_channel_response.enabled #=> true/false
resp.apns_sandbox_channel_response.has_credential #=> true/false
resp.apns_sandbox_channel_response.has_token_key #=> true/false
resp.apns_sandbox_channel_response.id #=> String
resp.apns_sandbox_channel_response.is_archived #=> true/false
resp.apns_sandbox_channel_response.last_modified_by #=> String
resp.apns_sandbox_channel_response.last_modified_date #=> String
resp.apns_sandbox_channel_response.platform #=> String
resp.apns_sandbox_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteApnsSandboxChannelResponse) —
Returns a response object which responds to the following methods:
- #apns_sandbox_channel_response => Types::APNSSandboxChannelResponse

See Also:

AWS API Documentation

#delete_apns_voip_channel(options = {}) ⇒ `Types::DeleteApnsVoipChannelResponse`

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_apns_voip_channel({
  application_id: "__string", # required
})

Response structure


resp.apns_voip_channel_response.application_id #=> String
resp.apns_voip_channel_response.creation_date #=> String
resp.apns_voip_channel_response.default_authentication_method #=> String
resp.apns_voip_channel_response.enabled #=> true/false
resp.apns_voip_channel_response.has_credential #=> true/false
resp.apns_voip_channel_response.has_token_key #=> true/false
resp.apns_voip_channel_response.id #=> String
resp.apns_voip_channel_response.is_archived #=> true/false
resp.apns_voip_channel_response.last_modified_by #=> String
resp.apns_voip_channel_response.last_modified_date #=> String
resp.apns_voip_channel_response.platform #=> String
resp.apns_voip_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteApnsVoipChannelResponse) —
Returns a response object which responds to the following methods:
- #apns_voip_channel_response => Types::APNSVoipChannelResponse

See Also:

AWS API Documentation

#delete_apns_voip_sandbox_channel(options = {}) ⇒ `Types::DeleteApnsVoipSandboxChannelResponse`

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_apns_voip_sandbox_channel({
  application_id: "__string", # required
})

Response structure


resp.apns_voip_sandbox_channel_response.application_id #=> String
resp.apns_voip_sandbox_channel_response.creation_date #=> String
resp.apns_voip_sandbox_channel_response.default_authentication_method #=> String
resp.apns_voip_sandbox_channel_response.enabled #=> true/false
resp.apns_voip_sandbox_channel_response.has_credential #=> true/false
resp.apns_voip_sandbox_channel_response.has_token_key #=> true/false
resp.apns_voip_sandbox_channel_response.id #=> String
resp.apns_voip_sandbox_channel_response.is_archived #=> true/false
resp.apns_voip_sandbox_channel_response.last_modified_by #=> String
resp.apns_voip_sandbox_channel_response.last_modified_date #=> String
resp.apns_voip_sandbox_channel_response.platform #=> String
resp.apns_voip_sandbox_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteApnsVoipSandboxChannelResponse) —
Returns a response object which responds to the following methods:
- #apns_voip_sandbox_channel_response => Types::APNSVoipSandboxChannelResponse

See Also:

AWS API Documentation

#delete_app(options = {}) ⇒ `Types::DeleteAppResponse`

Deletes an application.

Examples:

Request syntax with placeholder values


resp = client.delete_app({
  application_id: "__string", # required
})

Response structure


resp.application_response.arn #=> String
resp.application_response.id #=> String
resp.application_response.name #=> String
resp.application_response.tags #=> Hash
resp.application_response.tags["__string"] #=> String

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteAppResponse) —
Returns a response object which responds to the following methods:
- #application_response => Types::ApplicationResponse

See Also:

AWS API Documentation

#delete_baidu_channel(options = {}) ⇒ `Types::DeleteBaiduChannelResponse`

Disables the Baidu channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_baidu_channel({
  application_id: "__string", # required
})

Response structure


resp.baidu_channel_response.application_id #=> String
resp.baidu_channel_response.creation_date #=> String
resp.baidu_channel_response.credential #=> String
resp.baidu_channel_response.enabled #=> true/false
resp.baidu_channel_response.has_credential #=> true/false
resp.baidu_channel_response.id #=> String
resp.baidu_channel_response.is_archived #=> true/false
resp.baidu_channel_response.last_modified_by #=> String
resp.baidu_channel_response.last_modified_date #=> String
resp.baidu_channel_response.platform #=> String
resp.baidu_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteBaiduChannelResponse) —
Returns a response object which responds to the following methods:
- #baidu_channel_response => Types::BaiduChannelResponse

See Also:

AWS API Documentation

#delete_campaign(options = {}) ⇒ `Types::DeleteCampaignResponse`

Deletes a campaign from an application.

Examples:

Request syntax with placeholder values


resp = client.delete_campaign({
  application_id: "__string", # required
  campaign_id: "__string", # required
})

Response structure


resp.campaign_response.additional_treatments #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.campaign_response.additional_treatments[0].id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.adm_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.from_address #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.html_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> true/false
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaign_response.additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaign_response.additional_treatments[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> true/false
resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
resp.campaign_response.additional_treatments[0].size_percent #=> Integer
resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> true/false
resp.campaign_response.last_modified_date #=> String
resp.campaign_response.limits.daily #=> Integer
resp.campaign_response.limits.maximum_duration #=> Integer
resp.campaign_response.limits.messages_per_second #=> Integer
resp.campaign_response.limits.total #=> Integer
resp.campaign_response.message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.adm_message.body #=> String
resp.campaign_response.message_configuration.adm_message.image_icon_url #=> String
resp.campaign_response.message_configuration.adm_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.adm_message.image_url #=> String
resp.campaign_response.message_configuration.adm_message.json_body #=> String
resp.campaign_response.message_configuration.adm_message.media_url #=> String
resp.campaign_response.message_configuration.adm_message.raw_content #=> String
resp.campaign_response.message_configuration.adm_message.silent_push #=> true/false
resp.campaign_response.message_configuration.adm_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.adm_message.title #=> String
resp.campaign_response.message_configuration.adm_message.url #=> String
resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.apns_message.body #=> String
resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
resp.campaign_response.message_configuration.apns_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.apns_message.image_url #=> String
resp.campaign_response.message_configuration.apns_message.json_body #=> String
resp.campaign_response.message_configuration.apns_message.media_url #=> String
resp.campaign_response.message_configuration.apns_message.raw_content #=> String
resp.campaign_response.message_configuration.apns_message.silent_push #=> true/false
resp.campaign_response.message_configuration.apns_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.apns_message.title #=> String
resp.campaign_response.message_configuration.apns_message.url #=> String
resp.campaign_response.message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.baidu_message.body #=> String
resp.campaign_response.message_configuration.baidu_message.image_icon_url #=> String
resp.campaign_response.message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.baidu_message.image_url #=> String
resp.campaign_response.message_configuration.baidu_message.json_body #=> String
resp.campaign_response.message_configuration.baidu_message.media_url #=> String
resp.campaign_response.message_configuration.baidu_message.raw_content #=> String
resp.campaign_response.message_configuration.baidu_message.silent_push #=> true/false
resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.baidu_message.title #=> String
resp.campaign_response.message_configuration.baidu_message.url #=> String
resp.campaign_response.message_configuration.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> true/false
resp.campaign_response.message_configuration.default_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.default_message.title #=> String
resp.campaign_response.message_configuration.default_message.url #=> String
resp.campaign_response.message_configuration.email_message.body #=> String
resp.campaign_response.message_configuration.email_message.from_address #=> String
resp.campaign_response.message_configuration.email_message.html_body #=> String
resp.campaign_response.message_configuration.email_message.title #=> String
resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.gcm_message.body #=> String
resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
resp.campaign_response.message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.gcm_message.image_url #=> String
resp.campaign_response.message_configuration.gcm_message.json_body #=> String
resp.campaign_response.message_configuration.gcm_message.media_url #=> String
resp.campaign_response.message_configuration.gcm_message.raw_content #=> String
resp.campaign_response.message_configuration.gcm_message.silent_push #=> true/false
resp.campaign_response.message_configuration.gcm_message.time_to_live #=> Integer
resp.campaign_response.message_configuration.gcm_message.title #=> String
resp.campaign_response.message_configuration.gcm_message.url #=> String
resp.campaign_response.message_configuration.sms_message.body #=> String
resp.campaign_response.message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.name #=> String
resp.campaign_response.schedule.end_time #=> String
resp.campaign_response.schedule.event_filter.dimensions.attributes #=> Hash
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaign_response.schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaign_response.schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaign_response.schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaign_response.schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaign_response.schedule.event_filter.dimensions.metrics #=> Hash
resp.campaign_response.schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaign_response.schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaign_response.schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaign_response.schedule.is_local_time #=> true/false
resp.campaign_response.schedule.quiet_time.end #=> String
resp.campaign_response.schedule.quiet_time.start #=> String
resp.campaign_response.schedule.start_time #=> String
resp.campaign_response.schedule.timezone #=> String
resp.campaign_response.segment_id #=> String
resp.campaign_response.segment_version #=> Integer
resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer

Options Hash (options):

:application_id (required, String)
:campaign_id (required, String)

Returns:

(Types::DeleteCampaignResponse) —
Returns a response object which responds to the following methods:
- #campaign_response => Types::CampaignResponse

See Also:

AWS API Documentation

#delete_email_channel(options = {}) ⇒ `Types::DeleteEmailChannelResponse`

Disables the email channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_email_channel({
  application_id: "__string", # required
})

Response structure


resp.email_channel_response.application_id #=> String
resp.email_channel_response.configuration_set #=> String
resp.email_channel_response.creation_date #=> String
resp.email_channel_response.enabled #=> true/false
resp.email_channel_response.from_address #=> String
resp.email_channel_response.has_credential #=> true/false
resp.email_channel_response.id #=> String
resp.email_channel_response.identity #=> String
resp.email_channel_response.is_archived #=> true/false
resp.email_channel_response.last_modified_by #=> String
resp.email_channel_response.last_modified_date #=> String
resp.email_channel_response.messages_per_second #=> Integer
resp.email_channel_response.platform #=> String
resp.email_channel_response.role_arn #=> String
resp.email_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteEmailChannelResponse) —
Returns a response object which responds to the following methods:
- #email_channel_response => Types::EmailChannelResponse

See Also:

AWS API Documentation

#delete_email_template(options = {}) ⇒ `Types::DeleteEmailTemplateResponse`

Deletes a message template for messages that were sent through the email channel.

Examples:

Request syntax with placeholder values


resp = client.delete_email_template({
  template_name: "__string", # required
  version: "__string",
})

Response structure


resp.message_body.message #=> String
resp.message_body.request_id #=> String

Options Hash (options):

:template_name (required, String)
:version (String)

Returns:

(Types::DeleteEmailTemplateResponse) —
Returns a response object which responds to the following methods:
- #message_body => Types::MessageBody

See Also:

AWS API Documentation

#delete_endpoint(options = {}) ⇒ `Types::DeleteEndpointResponse`

Deletes an endpoint from an application.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint({
  application_id: "__string", # required
  endpoint_id: "__string", # required
})

Response structure


resp.endpoint_response.address #=> String
resp.endpoint_response.application_id #=> String
resp.endpoint_response.attributes #=> Hash
resp.endpoint_response.attributes["__string"] #=> Array
resp.endpoint_response.attributes["__string"][0] #=> String
resp.endpoint_response.channel_type #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.endpoint_response.cohort_id #=> String
resp.endpoint_response.creation_date #=> String
resp.endpoint_response.demographic.app_version #=> String
resp.endpoint_response.demographic.locale #=> String
resp.endpoint_response.demographic.make #=> String
resp.endpoint_response.demographic.model #=> String
resp.endpoint_response.demographic.model_version #=> String
resp.endpoint_response.demographic.platform #=> String
resp.endpoint_response.demographic.platform_version #=> String
resp.endpoint_response.demographic.timezone #=> String
resp.endpoint_response.effective_date #=> String
resp.endpoint_response.endpoint_status #=> String
resp.endpoint_response.id #=> String
resp.endpoint_response.location.city #=> String
resp.endpoint_response.location.country #=> String
resp.endpoint_response.location.latitude #=> Float
resp.endpoint_response.location.longitude #=> Float
resp.endpoint_response.location.postal_code #=> String
resp.endpoint_response.location.region #=> String
resp.endpoint_response.metrics #=> Hash
resp.endpoint_response.metrics["__string"] #=> Float
resp.endpoint_response.opt_out #=> String
resp.endpoint_response.request_id #=> String
resp.endpoint_response.user.user_attributes #=> Hash
resp.endpoint_response.user.user_attributes["__string"] #=> Array
resp.endpoint_response.user.user_attributes["__string"][0] #=> String
resp.endpoint_response.user.user_id #=> String

Options Hash (options):

:application_id (required, String)
:endpoint_id (required, String)

Returns:

(Types::DeleteEndpointResponse) —
Returns a response object which responds to the following methods:
- #endpoint_response => Types::EndpointResponse

See Also:

AWS API Documentation

#delete_event_stream(options = {}) ⇒ `Types::DeleteEventStreamResponse`

Deletes the event stream for an application.

Examples:

Request syntax with placeholder values


resp = client.delete_event_stream({
  application_id: "__string", # required
})

Response structure


resp.event_stream.application_id #=> String
resp.event_stream.destination_stream_arn #=> String
resp.event_stream.external_id #=> String
resp.event_stream.last_modified_date #=> String
resp.event_stream.last_updated_by #=> String
resp.event_stream.role_arn #=> String

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteEventStreamResponse) —
Returns a response object which responds to the following methods:
- #event_stream => Types::EventStream

See Also:

AWS API Documentation

#delete_gcm_channel(options = {}) ⇒ `Types::DeleteGcmChannelResponse`

Disables the GCM channel for an application and deletes any existing settings for the channel.

Examples:

Request syntax with placeholder values


resp = client.delete_gcm_channel({
  application_id: "__string", # required
})

Response structure


resp.gcm_channel_response.application_id #=> String
resp.gcm_channel_response.creation_date #=> String
resp.gcm_channel_response.credential #=> String
resp.gcm_channel_response.enabled #=> true/false
resp.gcm_channel_response.has_credential #=> true/false
resp.gcm_channel_response.id #=> String
resp.gcm_channel_response.is_archived #=> true/false
resp.gcm_channel_response.last_modified_by #=> String
resp.gcm_channel_response.last_modified_date #=> String
resp.gcm_channel_response.platform #=> String
resp.gcm_channel_response.version #=> Integer

Options Hash (options):

:application_id (required, String)

Returns:

(Types::DeleteGcmChannelResponse) —
Returns a response object which responds to the following methods:
- #gcm_channel_response => Types::GCMChannelResponse

See Also:

AWS API Documentation

#delete_journey(options = {}) ⇒ `Types::DeleteJourneyResponse`

Deletes a journey from an application.

Examples:

Request syntax with placeholder values


resp = client.delete_journey({
  application_id: "__string", # required
  journey_id: "__string", # required
})

Response structure


resp.journey_response.activities #=> Hash
resp.journey_response.activities["__string"].custom.delivery_uri #=> String
resp.journey_response.activities["__string"].custom.endpoint_types #=> Array
resp.journey_response.activities["__string"].custom.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.journey_response.activities["__string"].custom.message_config.data #=> String
resp.journey_response.activities["__string"].custom.next_activity #=> String
resp.journey_response.activities["__string"].custom.template_name #=> String
resp.journey_response.activities["__string"].custom.template_version #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].event_condition.message_activity #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_condition.segment_id #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes #=> Hash
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].conditional_split.condition.operator #=> String, one of "ALL", "ANY"
resp.journey_response.activities["__string"].conditional_split.evaluation_wait_time.wait_for #=> String
resp.journey_response.activities["__string"].conditional_split.evaluation_wait_time.wait_until #=> String
resp.journey_response.activities["__string"].conditional_split.false_activity #=> String
resp.journey_response.activities["__string"].conditional_split.true_activity #=> String
resp.journey_response.activities["__string"].description #=> String
resp.journey_response.activities["__string"].email.message_config.from_address #=> String
resp.journey_response.activities["__string"].email.next_activity #=> String
resp.journey_response.activities["__string"].email.template_name #=> String
resp.journey_response.activities["__string"].email.template_version #=> String
resp.journey_response.activities["__string"].holdout.next_activity #=> String
resp.journey_response.activities["__string"].holdout.percentage #=> Integer
resp.journey_response.activities["__string"].multi_condition.branches #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].value #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.event_condition.message_activity #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_condition.segment_id #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes #=> Hash
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values #=> Array
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values[0] #=> String
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journey_response.activities["__string"].multi_condition.branches[0].condition.segment_dimensions

Class: Aws::Pinpoint::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::Pinpoint::Client

Instance Method Details

#create_app(options = {}) ⇒ Types::CreateAppResponse

#create_campaign(options = {}) ⇒ Types::CreateCampaignResponse

#create_email_template(options = {}) ⇒ Types::CreateEmailTemplateResponse

#create_export_job(options = {}) ⇒ Types::CreateExportJobResponse

#create_import_job(options = {}) ⇒ Types::CreateImportJobResponse

#create_journey(options = {}) ⇒ Types::CreateJourneyResponse

#create_push_template(options = {}) ⇒ Types::CreatePushTemplateResponse

#create_recommender_configuration(options = {}) ⇒ Types::CreateRecommenderConfigurationResponse

#create_segment(options = {}) ⇒ Types::CreateSegmentResponse

#create_sms_template(options = {}) ⇒ Types::CreateSmsTemplateResponse

#create_voice_template(options = {}) ⇒ Types::CreateVoiceTemplateResponse

#delete_adm_channel(options = {}) ⇒ Types::DeleteAdmChannelResponse

#delete_apns_channel(options = {}) ⇒ Types::DeleteApnsChannelResponse

#delete_apns_sandbox_channel(options = {}) ⇒ Types::DeleteApnsSandboxChannelResponse

#delete_apns_voip_channel(options = {}) ⇒ Types::DeleteApnsVoipChannelResponse

#delete_apns_voip_sandbox_channel(options = {}) ⇒ Types::DeleteApnsVoipSandboxChannelResponse

#delete_app(options = {}) ⇒ Types::DeleteAppResponse

#delete_baidu_channel(options = {}) ⇒ Types::DeleteBaiduChannelResponse

#delete_campaign(options = {}) ⇒ Types::DeleteCampaignResponse

#delete_email_channel(options = {}) ⇒ Types::DeleteEmailChannelResponse

#delete_email_template(options = {}) ⇒ Types::DeleteEmailTemplateResponse

#delete_endpoint(options = {}) ⇒ Types::DeleteEndpointResponse

#delete_event_stream(options = {}) ⇒ Types::DeleteEventStreamResponse

#delete_gcm_channel(options = {}) ⇒ Types::DeleteGcmChannelResponse

#delete_journey(options = {}) ⇒ Types::DeleteJourneyResponse

#initialize(options = {}) ⇒ `Aws::Pinpoint::Client`

#create_app(options = {}) ⇒ `Types::CreateAppResponse`

#create_campaign(options = {}) ⇒ `Types::CreateCampaignResponse`

#create_email_template(options = {}) ⇒ `Types::CreateEmailTemplateResponse`

#create_export_job(options = {}) ⇒ `Types::CreateExportJobResponse`

#create_import_job(options = {}) ⇒ `Types::CreateImportJobResponse`

#create_journey(options = {}) ⇒ `Types::CreateJourneyResponse`

#create_push_template(options = {}) ⇒ `Types::CreatePushTemplateResponse`

#create_recommender_configuration(options = {}) ⇒ `Types::CreateRecommenderConfigurationResponse`

#create_segment(options = {}) ⇒ `Types::CreateSegmentResponse`

#create_sms_template(options = {}) ⇒ `Types::CreateSmsTemplateResponse`

#create_voice_template(options = {}) ⇒ `Types::CreateVoiceTemplateResponse`

#delete_adm_channel(options = {}) ⇒ `Types::DeleteAdmChannelResponse`

#delete_apns_channel(options = {}) ⇒ `Types::DeleteApnsChannelResponse`

#delete_apns_sandbox_channel(options = {}) ⇒ `Types::DeleteApnsSandboxChannelResponse`

#delete_apns_voip_channel(options = {}) ⇒ `Types::DeleteApnsVoipChannelResponse`

#delete_apns_voip_sandbox_channel(options = {}) ⇒ `Types::DeleteApnsVoipSandboxChannelResponse`

#delete_app(options = {}) ⇒ `Types::DeleteAppResponse`

#delete_baidu_channel(options = {}) ⇒ `Types::DeleteBaiduChannelResponse`

#delete_campaign(options = {}) ⇒ `Types::DeleteCampaignResponse`

#delete_email_channel(options = {}) ⇒ `Types::DeleteEmailChannelResponse`

#delete_email_template(options = {}) ⇒ `Types::DeleteEmailTemplateResponse`

#delete_endpoint(options = {}) ⇒ `Types::DeleteEndpointResponse`

#delete_event_stream(options = {}) ⇒ `Types::DeleteEventStreamResponse`

#delete_gcm_channel(options = {}) ⇒ `Types::DeleteGcmChannelResponse`

#delete_journey(options = {}) ⇒ `Types::DeleteJourneyResponse`