Class: Aws::Pinpoint::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Pinpoint::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-pinpoint/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates or updates an app.
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates or updates a campaign.
-
#create_export_job(params = {}) ⇒ Types::CreateExportJobResponse
Creates an export job.
-
#create_import_job(params = {}) ⇒ Types::CreateImportJobResponse
Creates or updates an import job.
-
#create_segment(params = {}) ⇒ Types::CreateSegmentResponse
Used to create or update a segment.
-
#delete_adm_channel(params = {}) ⇒ Types::DeleteAdmChannelResponse
Delete an ADM channel.
-
#delete_apns_channel(params = {}) ⇒ Types::DeleteApnsChannelResponse
Deletes the APNs channel for an app.
-
#delete_apns_sandbox_channel(params = {}) ⇒ Types::DeleteApnsSandboxChannelResponse
Delete an APNS sandbox channel.
-
#delete_apns_voip_channel(params = {}) ⇒ Types::DeleteApnsVoipChannelResponse
Delete an APNS VoIP channel.
-
#delete_apns_voip_sandbox_channel(params = {}) ⇒ Types::DeleteApnsVoipSandboxChannelResponse
Delete an APNS VoIP sandbox channel.
-
#delete_app(params = {}) ⇒ Types::DeleteAppResponse
Deletes an app.
-
#delete_baidu_channel(params = {}) ⇒ Types::DeleteBaiduChannelResponse
Delete a BAIDU GCM channel.
-
#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse
Deletes a campaign.
-
#delete_email_channel(params = {}) ⇒ Types::DeleteEmailChannelResponse
Delete an email channel.
-
#delete_endpoint(params = {}) ⇒ Types::DeleteEndpointResponse
Deletes an endpoint.
-
#delete_event_stream(params = {}) ⇒ Types::DeleteEventStreamResponse
Deletes the event stream for an app.
-
#delete_gcm_channel(params = {}) ⇒ Types::DeleteGcmChannelResponse
Deletes the GCM channel for an app.
-
#delete_segment(params = {}) ⇒ Types::DeleteSegmentResponse
Deletes a segment.
-
#delete_sms_channel(params = {}) ⇒ Types::DeleteSmsChannelResponse
Delete an SMS channel.
-
#delete_user_endpoints(params = {}) ⇒ Types::DeleteUserEndpointsResponse
Deletes endpoints that are associated with a User ID.
-
#delete_voice_channel(params = {}) ⇒ Types::DeleteVoiceChannelResponse
Delete an Voice channel.
-
#get_adm_channel(params = {}) ⇒ Types::GetAdmChannelResponse
Get an ADM channel.
-
#get_apns_channel(params = {}) ⇒ Types::GetApnsChannelResponse
Returns information about the APNs channel for an app.
-
#get_apns_sandbox_channel(params = {}) ⇒ Types::GetApnsSandboxChannelResponse
Get an APNS sandbox channel.
-
#get_apns_voip_channel(params = {}) ⇒ Types::GetApnsVoipChannelResponse
Get an APNS VoIP channel.
-
#get_apns_voip_sandbox_channel(params = {}) ⇒ Types::GetApnsVoipSandboxChannelResponse
Get an APNS VoIPSandbox channel.
-
#get_app(params = {}) ⇒ Types::GetAppResponse
Returns information about an app.
-
#get_application_settings(params = {}) ⇒ Types::GetApplicationSettingsResponse
Used to request the settings for an app.
-
#get_apps(params = {}) ⇒ Types::GetAppsResponse
Returns information about your apps.
-
#get_baidu_channel(params = {}) ⇒ Types::GetBaiduChannelResponse
Get a BAIDU GCM channel.
-
#get_campaign(params = {}) ⇒ Types::GetCampaignResponse
Returns information about a campaign.
-
#get_campaign_activities(params = {}) ⇒ Types::GetCampaignActivitiesResponse
Returns information about the activity performed by a campaign.
-
#get_campaign_version(params = {}) ⇒ Types::GetCampaignVersionResponse
Returns information about a specific version of a campaign.
-
#get_campaign_versions(params = {}) ⇒ Types::GetCampaignVersionsResponse
Returns information about your campaign versions.
-
#get_campaigns(params = {}) ⇒ Types::GetCampaignsResponse
Returns information about your campaigns.
-
#get_channels(params = {}) ⇒ Types::GetChannelsResponse
Get all channels.
-
#get_email_channel(params = {}) ⇒ Types::GetEmailChannelResponse
Get an email channel.
-
#get_endpoint(params = {}) ⇒ Types::GetEndpointResponse
Returns information about an endpoint.
-
#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse
Returns the event stream for an app.
-
#get_export_job(params = {}) ⇒ Types::GetExportJobResponse
Returns information about an export job.
-
#get_export_jobs(params = {}) ⇒ Types::GetExportJobsResponse
Returns information about your export jobs.
-
#get_gcm_channel(params = {}) ⇒ Types::GetGcmChannelResponse
Returns information about the GCM channel for an app.
-
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Returns information about an import job.
-
#get_import_jobs(params = {}) ⇒ Types::GetImportJobsResponse
Returns information about your import jobs.
-
#get_segment(params = {}) ⇒ Types::GetSegmentResponse
Returns information about a segment.
-
#get_segment_export_jobs(params = {}) ⇒ Types::GetSegmentExportJobsResponse
Returns a list of export jobs for a specific segment.
-
#get_segment_import_jobs(params = {}) ⇒ Types::GetSegmentImportJobsResponse
Returns a list of import jobs for a specific segment.
-
#get_segment_version(params = {}) ⇒ Types::GetSegmentVersionResponse
Returns information about a segment version.
-
#get_segment_versions(params = {}) ⇒ Types::GetSegmentVersionsResponse
Returns information about your segment versions.
-
#get_segments(params = {}) ⇒ Types::GetSegmentsResponse
Used to get information about your segments.
-
#get_sms_channel(params = {}) ⇒ Types::GetSmsChannelResponse
Get an SMS channel.
-
#get_user_endpoints(params = {}) ⇒ Types::GetUserEndpointsResponse
Returns information about the endpoints that are associated with a User ID.
-
#get_voice_channel(params = {}) ⇒ Types::GetVoiceChannelResponse
Get a Voice Channel.
-
#phone_number_validate(params = {}) ⇒ Types::PhoneNumberValidateResponse
Returns information about the specified phone number.
-
#put_event_stream(params = {}) ⇒ Types::PutEventStreamResponse
Use to create or update the event stream for an app.
-
#put_events(params = {}) ⇒ Types::PutEventsResponse
Use to record events for endpoints.
-
#remove_attributes(params = {}) ⇒ Types::RemoveAttributesResponse
Used to remove the attributes for an app.
-
#send_messages(params = {}) ⇒ Types::SendMessagesResponse
Used to send a direct message.
-
#send_users_messages(params = {}) ⇒ Types::SendUsersMessagesResponse
Used to send a message to a list of users.
-
#update_adm_channel(params = {}) ⇒ Types::UpdateAdmChannelResponse
Update an ADM channel.
-
#update_apns_channel(params = {}) ⇒ Types::UpdateApnsChannelResponse
Use to update the APNs channel for an app.
-
#update_apns_sandbox_channel(params = {}) ⇒ Types::UpdateApnsSandboxChannelResponse
Update an APNS sandbox channel.
-
#update_apns_voip_channel(params = {}) ⇒ Types::UpdateApnsVoipChannelResponse
Update an APNS VoIP channel.
-
#update_apns_voip_sandbox_channel(params = {}) ⇒ Types::UpdateApnsVoipSandboxChannelResponse
Update an APNS VoIP sandbox channel.
-
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsResponse
Used to update the settings for an app.
-
#update_baidu_channel(params = {}) ⇒ Types::UpdateBaiduChannelResponse
Update a BAIDU GCM channel.
-
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Use to update a campaign.
-
#update_email_channel(params = {}) ⇒ Types::UpdateEmailChannelResponse
Update an email channel.
-
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse
Creates or updates an endpoint.
-
#update_endpoints_batch(params = {}) ⇒ Types::UpdateEndpointsBatchResponse
Use to update a batch of endpoints.
-
#update_gcm_channel(params = {}) ⇒ Types::UpdateGcmChannelResponse
Use to update the GCM channel for an app.
-
#update_segment(params = {}) ⇒ Types::UpdateSegmentResponse
Used to update a segment.
-
#update_sms_channel(params = {}) ⇒ Types::UpdateSmsChannelResponse
Update an SMS channel.
-
#update_voice_channel(params = {}) ⇒ Types::UpdateVoiceChannelResponse
Update an Voice channel.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
-
‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
-
‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
-
‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.
-
‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
-
The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
-
‘~/.aws/credentials`
-
‘~/.aws/config`
-
EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.
-
- :region (required, String) —
- :access_key_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
-
:client_side_monitoring
(Boolean)
— default:
false
—
When ‘true`, client-side metrics will be collected for all API requests from this client.
-
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When ‘true`, an attempt is made to coerce request parameters into the required types.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:endpoint
(String)
—
The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.
-
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
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.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
-
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the ‘:logger` at.
-
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
-
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function.
-
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
-
: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.
-
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
- :secret_access_key (String)
- :session_token (String)
-
: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.
-
:validate_params
(Boolean)
— default:
true
—
When ‘true`, request parameters are validated before sending the request.
202 203 204 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 202 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6641 6642 6643 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6641 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6644 6645 6646 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6644 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Parameters:
- params ({}) (defaults to: {})
6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6619 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-pinpoint' context[:gem_version] = '1.14.0' Seahorse::Client::Request.new(handlers, context) end |
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates or updates an app.
Examples:
Request syntax with placeholder values
resp = client.create_app({
create_application_request: { # required
name: "__string",
},
})
Response structure
resp.application_response.id #=> String
resp.application_response.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:create_application_request
(required, Types::CreateApplicationRequest)
—
Application Request.
Returns:
-
(Types::CreateAppResponse)
—
Returns a response object which responds to the following methods:
-
#application_response => Types::ApplicationResponse
-
See Also:
234 235 236 237 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 234 def create_app(params = {}, options = {}) req = build_request(:create_app, params) req.send_request(options) end |
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates or updates a campaign.
Examples:
Request syntax with placeholder values
resp = client.create_campaign({
application_id: "__string", # required
write_campaign_request: { # required
additional_treatments: [
{
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",
},
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: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # 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",
timezone: "__string",
},
size_percent: 1,
treatment_description: "__string",
treatment_name: "__string",
},
],
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",
},
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: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # 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",
timezone: "__string",
},
segment_id: "__string",
segment_version: 1,
treatment_description: "__string",
treatment_name: "__string",
},
})
Response structure
resp.campaign_response.additional_treatments #=> Array
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
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.creation_date #=> String
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:write_campaign_request
(required, Types::WriteCampaignRequest)
—
Used to create a campaign.
Returns:
-
(Types::CreateCampaignResponse)
—
Returns a response object which responds to the following methods:
-
#campaign_response => Types::CampaignResponse
-
See Also:
719 720 721 722 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 719 def create_campaign(params = {}, options = {}) req = build_request(:create_campaign, params) req.send_request(options) end |
#create_export_job(params = {}) ⇒ Types::CreateExportJobResponse
Creates an export job.
Examples:
Request syntax with placeholder values
resp = client.create_export_job({
application_id: "__string", # required
export_job_request: { # required
role_arn: "__string",
s3_url_prefix: "__string",
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", "INITIALIZING", "PROCESSING", "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:export_job_request
(required, Types::ExportJobRequest)
—
Export job request.
Returns:
-
(Types::CreateExportJobResponse)
—
Returns a response object which responds to the following methods:
-
#export_job_response => Types::ExportJobResponse
-
See Also:
771 772 773 774 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 771 def create_export_job(params = {}, options = {}) req = build_request(:create_export_job, params) req.send_request(options) end |
#create_import_job(params = {}) ⇒ Types::CreateImportJobResponse
Creates or updates an import job.
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", # accepts CSV, JSON
register_endpoints: false,
role_arn: "__string",
s3_url: "__string",
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 #=> Boolean
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 #=> Boolean
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", "INITIALIZING", "PROCESSING", "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:import_job_request
(required, Types::ImportJobRequest)
—
Import job request.
Returns:
-
(Types::CreateImportJobResponse)
—
Returns a response object which responds to the following methods:
-
#import_job_response => Types::ImportJobResponse
-
See Also:
831 832 833 834 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 831 def create_import_job(params = {}, options = {}) req = build_request(:create_import_job, params) req.send_request(options) end |
#create_segment(params = {}) ⇒ Types::CreateSegmentResponse
Used to create or update a segment.
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"],
},
},
behavior: {
recency: {
duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
gps_point: {
coordinates: {
latitude: 1.0,
longitude: 1.0,
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
},
name: "__string",
segment_groups: {
groups: [
{
dimensions: [
{
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
behavior: {
recency: {
duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
gps_point: {
coordinates: {
latitude: 1.0,
longitude: 1.0,
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
},
],
source_segments: [
{
id: "__string",
version: 1,
},
],
source_type: "ALL", # accepts ALL, ANY, NONE
type: "ALL", # accepts ALL, ANY, NONE
},
],
include: "ALL", # accepts ALL, ANY, NONE
},
},
})
Response structure
resp.segment_response.application_id #=> 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.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:write_segment_request
(required, Types::WriteSegmentRequest)
—
Segment definition.
Returns:
-
(Types::CreateSegmentResponse)
—
Returns a response object which responds to the following methods:
-
#segment_response => Types::SegmentResponse
-
See Also:
1106 1107 1108 1109 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1106 def create_segment(params = {}, options = {}) req = build_request(:create_segment, params) req.send_request(options) end |
#delete_adm_channel(params = {}) ⇒ Types::DeleteAdmChannelResponse
Delete an ADM 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 #=> Boolean
resp.adm_channel_response.has_credential #=> Boolean
resp.adm_channel_response.id #=> String
resp.adm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteAdmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#adm_channel_response => Types::ADMChannelResponse
-
See Also:
1142 1143 1144 1145 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1142 def delete_adm_channel(params = {}, options = {}) req = build_request(:delete_adm_channel, params) req.send_request(options) end |
#delete_apns_channel(params = {}) ⇒ Types::DeleteApnsChannelResponse
Deletes the APNs channel for an app.
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 #=> Boolean
resp.apns_channel_response.has_credential #=> Boolean
resp.apns_channel_response.has_token_key #=> Boolean
resp.apns_channel_response.id #=> String
resp.apns_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteApnsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_channel_response => Types::APNSChannelResponse
-
See Also:
1180 1181 1182 1183 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1180 def delete_apns_channel(params = {}, options = {}) req = build_request(:delete_apns_channel, params) req.send_request(options) end |
#delete_apns_sandbox_channel(params = {}) ⇒ Types::DeleteApnsSandboxChannelResponse
Delete an APNS sandbox 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 #=> Boolean
resp.apns_sandbox_channel_response.has_credential #=> Boolean
resp.apns_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_sandbox_channel_response.id #=> String
resp.apns_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :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:
1218 1219 1220 1221 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1218 def delete_apns_sandbox_channel(params = {}, options = {}) req = build_request(:delete_apns_sandbox_channel, params) req.send_request(options) end |
#delete_apns_voip_channel(params = {}) ⇒ Types::DeleteApnsVoipChannelResponse
Delete an APNS VoIP 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 #=> Boolean
resp.apns_voip_channel_response.has_credential #=> Boolean
resp.apns_voip_channel_response.has_token_key #=> Boolean
resp.apns_voip_channel_response.id #=> String
resp.apns_voip_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :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:
1256 1257 1258 1259 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1256 def delete_apns_voip_channel(params = {}, options = {}) req = build_request(:delete_apns_voip_channel, params) req.send_request(options) end |
#delete_apns_voip_sandbox_channel(params = {}) ⇒ Types::DeleteApnsVoipSandboxChannelResponse
Delete an APNS VoIP sandbox 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 #=> Boolean
resp.apns_voip_sandbox_channel_response.has_credential #=> Boolean
resp.apns_voip_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_voip_sandbox_channel_response.id #=> String
resp.apns_voip_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :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:
1294 1295 1296 1297 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1294 def delete_apns_voip_sandbox_channel(params = {}, options = {}) req = build_request(:delete_apns_voip_sandbox_channel, params) req.send_request(options) end |
#delete_app(params = {}) ⇒ Types::DeleteAppResponse
Deletes an app.
Examples:
Request syntax with placeholder values
resp = client.delete_app({
application_id: "__string", # required
})
Response structure
resp.application_response.id #=> String
resp.application_response.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteAppResponse)
—
Returns a response object which responds to the following methods:
-
#application_response => Types::ApplicationResponse
-
See Also:
1322 1323 1324 1325 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1322 def delete_app(params = {}, options = {}) req = build_request(:delete_app, params) req.send_request(options) end |
#delete_baidu_channel(params = {}) ⇒ Types::DeleteBaiduChannelResponse
Delete a BAIDU GCM 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 #=> Boolean
resp.baidu_channel_response.has_credential #=> Boolean
resp.baidu_channel_response.id #=> String
resp.baidu_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteBaiduChannelResponse)
—
Returns a response object which responds to the following methods:
-
#baidu_channel_response => Types::BaiduChannelResponse
-
See Also:
1359 1360 1361 1362 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1359 def delete_baidu_channel(params = {}, options = {}) req = build_request(:delete_baidu_channel, params) req.send_request(options) end |
#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse
Deletes a campaign.
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].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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
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.creation_date #=> String
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :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:
1586 1587 1588 1589 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1586 def delete_campaign(params = {}, options = {}) req = build_request(:delete_campaign, params) req.send_request(options) end |
#delete_email_channel(params = {}) ⇒ Types::DeleteEmailChannelResponse
Delete an email 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 #=> Boolean
resp.email_channel_response.from_address #=> String
resp.email_channel_response.has_credential #=> Boolean
resp.email_channel_response.id #=> String
resp.email_channel_response.identity #=> String
resp.email_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteEmailChannelResponse)
—
Returns a response object which responds to the following methods:
-
#email_channel_response => Types::EmailChannelResponse
-
See Also:
1627 1628 1629 1630 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1627 def delete_email_channel(params = {}, options = {}) req = build_request(:delete_email_channel, params) req.send_request(options) end |
#delete_endpoint(params = {}) ⇒ Types::DeleteEndpointResponse
Deletes an endpoint.
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 "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :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:
1689 1690 1691 1692 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1689 def delete_endpoint(params = {}, options = {}) req = build_request(:delete_endpoint, params) req.send_request(options) end |
#delete_event_stream(params = {}) ⇒ Types::DeleteEventStreamResponse
Deletes the event stream for an app.
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteEventStreamResponse)
—
Returns a response object which responds to the following methods:
-
#event_stream => Types::EventStream
-
See Also:
1721 1722 1723 1724 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1721 def delete_event_stream(params = {}, options = {}) req = build_request(:delete_event_stream, params) req.send_request(options) end |
#delete_gcm_channel(params = {}) ⇒ Types::DeleteGcmChannelResponse
Deletes the GCM channel for an app.
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 #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.id #=> String
resp.gcm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteGcmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#gcm_channel_response => Types::GCMChannelResponse
-
See Also:
1758 1759 1760 1761 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1758 def delete_gcm_channel(params = {}, options = {}) req = build_request(:delete_gcm_channel, params) req.send_request(options) end |
#delete_segment(params = {}) ⇒ Types::DeleteSegmentResponse
Deletes a segment.
Examples:
Request syntax with placeholder values
resp = client.delete_segment({
application_id: "__string", # required
segment_id: "__string", # required
})
Response structure
resp.segment_response.application_id #=> 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.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :segment_id (required, String)
Returns:
-
(Types::DeleteSegmentResponse)
—
Returns a response object which responds to the following methods:
-
#segment_response => Types::SegmentResponse
-
See Also:
1883 1884 1885 1886 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1883 def delete_segment(params = {}, options = {}) req = build_request(:delete_segment, params) req.send_request(options) end |
#delete_sms_channel(params = {}) ⇒ Types::DeleteSmsChannelResponse
Delete an SMS channel.
Examples:
Request syntax with placeholder values
resp = client.delete_sms_channel({
application_id: "__string", # required
})
Response structure
resp.sms_channel_response.application_id #=> String
resp.sms_channel_response.creation_date #=> String
resp.sms_channel_response.enabled #=> Boolean
resp.sms_channel_response.has_credential #=> Boolean
resp.sms_channel_response.id #=> String
resp.sms_channel_response.is_archived #=> Boolean
resp.sms_channel_response.last_modified_by #=> String
resp.sms_channel_response.last_modified_date #=> String
resp.sms_channel_response.platform #=> String
resp.sms_channel_response.promotional_messages_per_second #=> Integer
resp.sms_channel_response.sender_id #=> String
resp.sms_channel_response.short_code #=> String
resp.sms_channel_response.transactional_messages_per_second #=> Integer
resp.sms_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteSmsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#sms_channel_response => Types::SMSChannelResponse
-
See Also:
1923 1924 1925 1926 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1923 def delete_sms_channel(params = {}, options = {}) req = build_request(:delete_sms_channel, params) req.send_request(options) end |
#delete_user_endpoints(params = {}) ⇒ Types::DeleteUserEndpointsResponse
Deletes endpoints that are associated with a User ID.
Examples:
Request syntax with placeholder values
resp = client.delete_user_endpoints({
application_id: "__string", # required
user_id: "__string", # required
})
Response structure
resp.endpoints_response.item #=> Array
resp.endpoints_response.item[0].address #=> String
resp.endpoints_response.item[0].application_id #=> String
resp.endpoints_response.item[0].attributes #=> Hash
resp.endpoints_response.item[0].attributes["__string"] #=> Array
resp.endpoints_response.item[0].attributes["__string"][0] #=> String
resp.endpoints_response.item[0].channel_type #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.endpoints_response.item[0].cohort_id #=> String
resp.endpoints_response.item[0].creation_date #=> String
resp.endpoints_response.item[0].demographic.app_version #=> String
resp.endpoints_response.item[0].demographic.locale #=> String
resp.endpoints_response.item[0].demographic.make #=> String
resp.endpoints_response.item[0].demographic.model #=> String
resp.endpoints_response.item[0].demographic.model_version #=> String
resp.endpoints_response.item[0].demographic.platform #=> String
resp.endpoints_response.item[0].demographic.platform_version #=> String
resp.endpoints_response.item[0].demographic.timezone #=> String
resp.endpoints_response.item[0].effective_date #=> String
resp.endpoints_response.item[0].endpoint_status #=> String
resp.endpoints_response.item[0].id #=> String
resp.endpoints_response.item[0].location.city #=> String
resp.endpoints_response.item[0].location.country #=> String
resp.endpoints_response.item[0].location.latitude #=> Float
resp.endpoints_response.item[0].location.longitude #=> Float
resp.endpoints_response.item[0].location.postal_code #=> String
resp.endpoints_response.item[0].location.region #=> String
resp.endpoints_response.item[0].metrics #=> Hash
resp.endpoints_response.item[0].metrics["__string"] #=> Float
resp.endpoints_response.item[0].opt_out #=> String
resp.endpoints_response.item[0].request_id #=> String
resp.endpoints_response.item[0].user.user_attributes #=> Hash
resp.endpoints_response.item[0].user.user_attributes["__string"] #=> Array
resp.endpoints_response.item[0].user.user_attributes["__string"][0] #=> String
resp.endpoints_response.item[0].user.user_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :user_id (required, String)
Returns:
-
(Types::DeleteUserEndpointsResponse)
—
Returns a response object which responds to the following methods:
-
#endpoints_response => Types::EndpointsResponse
-
See Also:
1986 1987 1988 1989 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 1986 def delete_user_endpoints(params = {}, options = {}) req = build_request(:delete_user_endpoints, params) req.send_request(options) end |
#delete_voice_channel(params = {}) ⇒ Types::DeleteVoiceChannelResponse
Delete an Voice channel
Examples:
Request syntax with placeholder values
resp = client.delete_voice_channel({
application_id: "__string", # required
})
Response structure
resp.voice_channel_response.application_id #=> String
resp.voice_channel_response.creation_date #=> String
resp.voice_channel_response.enabled #=> Boolean
resp.voice_channel_response.has_credential #=> Boolean
resp.voice_channel_response.id #=> String
resp.voice_channel_response.is_archived #=> Boolean
resp.voice_channel_response.last_modified_by #=> String
resp.voice_channel_response.last_modified_date #=> String
resp.voice_channel_response.platform #=> String
resp.voice_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::DeleteVoiceChannelResponse)
—
Returns a response object which responds to the following methods:
-
#voice_channel_response => Types::VoiceChannelResponse
-
See Also:
2022 2023 2024 2025 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2022 def delete_voice_channel(params = {}, options = {}) req = build_request(:delete_voice_channel, params) req.send_request(options) end |
#get_adm_channel(params = {}) ⇒ Types::GetAdmChannelResponse
Get an ADM channel.
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.adm_channel_response.has_credential #=> Boolean
resp.adm_channel_response.id #=> String
resp.adm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetAdmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#adm_channel_response => Types::ADMChannelResponse
-
See Also:
2058 2059 2060 2061 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2058 def get_adm_channel(params = {}, options = {}) req = build_request(:get_adm_channel, params) req.send_request(options) end |
#get_apns_channel(params = {}) ⇒ Types::GetApnsChannelResponse
Returns information about the APNs channel for an app.
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.apns_channel_response.has_credential #=> Boolean
resp.apns_channel_response.has_token_key #=> Boolean
resp.apns_channel_response.id #=> String
resp.apns_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetApnsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_channel_response => Types::APNSChannelResponse
-
See Also:
2096 2097 2098 2099 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2096 def get_apns_channel(params = {}, options = {}) req = build_request(:get_apns_channel, params) req.send_request(options) end |
#get_apns_sandbox_channel(params = {}) ⇒ Types::GetApnsSandboxChannelResponse
Get an APNS sandbox channel.
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.apns_sandbox_channel_response.has_credential #=> Boolean
resp.apns_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_sandbox_channel_response.id #=> String
resp.apns_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetApnsSandboxChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_sandbox_channel_response => Types::APNSSandboxChannelResponse
-
See Also:
2134 2135 2136 2137 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2134 def get_apns_sandbox_channel(params = {}, options = {}) req = build_request(:get_apns_sandbox_channel, params) req.send_request(options) end |
#get_apns_voip_channel(params = {}) ⇒ Types::GetApnsVoipChannelResponse
Get an APNS VoIP channel
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.apns_voip_channel_response.has_credential #=> Boolean
resp.apns_voip_channel_response.has_token_key #=> Boolean
resp.apns_voip_channel_response.id #=> String
resp.apns_voip_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetApnsVoipChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_voip_channel_response => Types::APNSVoipChannelResponse
-
See Also:
2172 2173 2174 2175 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2172 def get_apns_voip_channel(params = {}, options = {}) req = build_request(:get_apns_voip_channel, params) req.send_request(options) end |
#get_apns_voip_sandbox_channel(params = {}) ⇒ Types::GetApnsVoipSandboxChannelResponse
Get an APNS VoIPSandbox channel
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.apns_voip_sandbox_channel_response.has_credential #=> Boolean
resp.apns_voip_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_voip_sandbox_channel_response.id #=> String
resp.apns_voip_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetApnsVoipSandboxChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_voip_sandbox_channel_response => Types::APNSVoipSandboxChannelResponse
-
See Also:
2210 2211 2212 2213 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2210 def get_apns_voip_sandbox_channel(params = {}, options = {}) req = build_request(:get_apns_voip_sandbox_channel, params) req.send_request(options) end |
#get_app(params = {}) ⇒ Types::GetAppResponse
Returns information about an app.
Examples:
Request syntax with placeholder values
resp = client.get_app({
application_id: "__string", # required
})
Response structure
resp.application_response.id #=> String
resp.application_response.name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetAppResponse)
—
Returns a response object which responds to the following methods:
-
#application_response => Types::ApplicationResponse
-
See Also:
2238 2239 2240 2241 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2238 def get_app(params = {}, options = {}) req = build_request(:get_app, params) req.send_request(options) end |
#get_application_settings(params = {}) ⇒ Types::GetApplicationSettingsResponse
Used to request the settings for an app.
Examples:
Request syntax with placeholder values
resp = client.get_application_settings({
application_id: "__string", # required
})
Response structure
resp.application_settings_resource.application_id #=> String
resp.application_settings_resource.campaign_hook.lambda_function_name #=> String
resp.application_settings_resource.campaign_hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.application_settings_resource.campaign_hook.web_url #=> String
resp.application_settings_resource.last_modified_date #=> String
resp.application_settings_resource.limits.daily #=> Integer
resp.application_settings_resource.limits.maximum_duration #=> Integer
resp.application_settings_resource.limits.messages_per_second #=> Integer
resp.application_settings_resource.limits.total #=> Integer
resp.application_settings_resource.quiet_time.end #=> String
resp.application_settings_resource.quiet_time.start #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetApplicationSettingsResponse)
—
Returns a response object which responds to the following methods:
-
#application_settings_resource => Types::ApplicationSettingsResource
-
See Also:
2275 2276 2277 2278 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2275 def get_application_settings(params = {}, options = {}) req = build_request(:get_application_settings, params) req.send_request(options) end |
#get_apps(params = {}) ⇒ Types::GetAppsResponse
Returns information about your apps.
Examples:
Request syntax with placeholder values
resp = client.get_apps({
page_size: "__string",
token: "__string",
})
Response structure
resp.applications_response.item #=> Array
resp.applications_response.item[0].id #=> String
resp.applications_response.item[0].name #=> String
resp.applications_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetAppsResponse)
—
Returns a response object which responds to the following methods:
-
#applications_response => Types::ApplicationsResponse
-
See Also:
2308 2309 2310 2311 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2308 def get_apps(params = {}, options = {}) req = build_request(:get_apps, params) req.send_request(options) end |
#get_baidu_channel(params = {}) ⇒ Types::GetBaiduChannelResponse
Get a BAIDU GCM channel
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.baidu_channel_response.has_credential #=> Boolean
resp.baidu_channel_response.id #=> String
resp.baidu_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetBaiduChannelResponse)
—
Returns a response object which responds to the following methods:
-
#baidu_channel_response => Types::BaiduChannelResponse
-
See Also:
2345 2346 2347 2348 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2345 def get_baidu_channel(params = {}, options = {}) req = build_request(:get_baidu_channel, params) req.send_request(options) end |
#get_campaign(params = {}) ⇒ Types::GetCampaignResponse
Returns information about a campaign.
Examples:
Request syntax with placeholder values
resp = client.get_campaign({
application_id: "__string", # required
campaign_id: "__string", # required
})
Response structure
resp.campaign_response.additional_treatments #=> Array
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
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.creation_date #=> String
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :campaign_id (required, String)
Returns:
-
(Types::GetCampaignResponse)
—
Returns a response object which responds to the following methods:
-
#campaign_response => Types::CampaignResponse
-
See Also:
2572 2573 2574 2575 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2572 def get_campaign(params = {}, options = {}) req = build_request(:get_campaign, params) req.send_request(options) end |
#get_campaign_activities(params = {}) ⇒ Types::GetCampaignActivitiesResponse
Returns information about the activity performed by a campaign.
Examples:
Request syntax with placeholder values
resp = client.get_campaign_activities({
application_id: "__string", # required
campaign_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.activities_response.item #=> Array
resp.activities_response.item[0].application_id #=> String
resp.activities_response.item[0].campaign_id #=> String
resp.activities_response.item[0].end #=> String
resp.activities_response.item[0].id #=> String
resp.activities_response.item[0].result #=> String
resp.activities_response.item[0].scheduled_start #=> String
resp.activities_response.item[0].start #=> String
resp.activities_response.item[0].state #=> String
resp.activities_response.item[0].successful_endpoint_count #=> Integer
resp.activities_response.item[0].timezones_completed_count #=> Integer
resp.activities_response.item[0].timezones_total_count #=> Integer
resp.activities_response.item[0].total_endpoint_count #=> Integer
resp.activities_response.item[0].treatment_id #=> String
resp.activities_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :campaign_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetCampaignActivitiesResponse)
—
Returns a response object which responds to the following methods:
-
#activities_response => Types::ActivitiesResponse
-
See Also:
2622 2623 2624 2625 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2622 def get_campaign_activities(params = {}, options = {}) req = build_request(:get_campaign_activities, params) req.send_request(options) end |
#get_campaign_version(params = {}) ⇒ Types::GetCampaignVersionResponse
Returns information about a specific version of a campaign.
Examples:
Request syntax with placeholder values
resp = client.get_campaign_version({
application_id: "__string", # required
campaign_id: "__string", # required
version: "__string", # required
})
Response structure
resp.campaign_response.additional_treatments #=> Array
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
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.creation_date #=> String
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :campaign_id (required, String)
- :version (required, String)
Returns:
-
(Types::GetCampaignVersionResponse)
—
Returns a response object which responds to the following methods:
-
#campaign_response => Types::CampaignResponse
-
See Also:
2852 2853 2854 2855 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 2852 def get_campaign_version(params = {}, options = {}) req = build_request(:get_campaign_version, params) req.send_request(options) end |
#get_campaign_versions(params = {}) ⇒ Types::GetCampaignVersionsResponse
Returns information about your campaign versions.
Examples:
Request syntax with placeholder values
resp = client.get_campaign_versions({
application_id: "__string", # required
campaign_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.campaigns_response.item #=> Array
resp.campaigns_response.item[0].additional_treatments #=> Array
resp.campaigns_response.item[0].additional_treatments[0].id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.from_address #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.html_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.end_time #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaigns_response.item[0].additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaigns_response.item[0].additional_treatments[0].schedule.is_local_time #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.end #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.start #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.start_time #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
resp.campaigns_response.item[0].application_id #=> String
resp.campaigns_response.item[0].creation_date #=> String
resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].description #=> String
resp.campaigns_response.item[0].holdout_percent #=> Integer
resp.campaigns_response.item[0].hook.lambda_function_name #=> String
resp.campaigns_response.item[0].hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaigns_response.item[0].hook.web_url #=> String
resp.campaigns_response.item[0].id #=> String
resp.campaigns_response.item[0].is_paused #=> Boolean
resp.campaigns_response.item[0].last_modified_date #=> String
resp.campaigns_response.item[0].limits.daily #=> Integer
resp.campaigns_response.item[0].limits.maximum_duration #=> Integer
resp.campaigns_response.item[0].limits.messages_per_second #=> Integer
resp.campaigns_response.item[0].limits.total #=> Integer
resp.campaigns_response.item[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.adm_message.body #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.adm_message.title #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.apns_message.body #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.apns_message.title #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.baidu_message.body #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.baidu_message.title #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.default_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.default_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.default_message.title #=> String
resp.campaigns_response.item[0].message_configuration.default_message.url #=> String
resp.campaigns_response.item[0].message_configuration.email_message.body #=> String
resp.campaigns_response.item[0].message_configuration.email_message.from_address #=> String
resp.campaigns_response.item[0].message_configuration.email_message.html_body #=> String
resp.campaigns_response.item[0].message_configuration.email_message.title #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.gcm_message.body #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.gcm_message.title #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.url #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.body #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaigns_response.item[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].name #=> String
resp.campaigns_response.item[0].schedule.end_time #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaigns_response.item[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaigns_response.item[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaigns_response.item[0].schedule.is_local_time #=> Boolean
resp.campaigns_response.item[0].schedule.quiet_time.end #=> String
resp.campaigns_response.item[0].schedule.quiet_time.start #=> String
resp.campaigns_response.item[0].schedule.start_time #=> String
resp.campaigns_response.item[0].schedule.timezone #=> String
resp.campaigns_response.item[0].segment_id #=> String
resp.campaigns_response.item[0].segment_version #=> Integer
resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].treatment_description #=> String
resp.campaigns_response.item[0].treatment_name #=> String
resp.campaigns_response.item[0].version #=> Integer
resp.campaigns_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :campaign_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetCampaignVersionsResponse)
—
Returns a response object which responds to the following methods:
-
#campaigns_response => Types::CampaignsResponse
-
See Also:
3087 3088 3089 3090 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3087 def get_campaign_versions(params = {}, options = {}) req = build_request(:get_campaign_versions, params) req.send_request(options) end |
#get_campaigns(params = {}) ⇒ Types::GetCampaignsResponse
Returns information about your campaigns.
Examples:
Request syntax with placeholder values
resp = client.get_campaigns({
application_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.campaigns_response.item #=> Array
resp.campaigns_response.item[0].additional_treatments #=> Array
resp.campaigns_response.item[0].additional_treatments[0].id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.from_address #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.html_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.json_body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.media_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.raw_content #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.title #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.end_time #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaigns_response.item[0].additional_treatments[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaigns_response.item[0].additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaigns_response.item[0].additional_treatments[0].schedule.is_local_time #=> Boolean
resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.end #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.start #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.start_time #=> String
resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
resp.campaigns_response.item[0].application_id #=> String
resp.campaigns_response.item[0].creation_date #=> String
resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].description #=> String
resp.campaigns_response.item[0].holdout_percent #=> Integer
resp.campaigns_response.item[0].hook.lambda_function_name #=> String
resp.campaigns_response.item[0].hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaigns_response.item[0].hook.web_url #=> String
resp.campaigns_response.item[0].id #=> String
resp.campaigns_response.item[0].is_paused #=> Boolean
resp.campaigns_response.item[0].last_modified_date #=> String
resp.campaigns_response.item[0].limits.daily #=> Integer
resp.campaigns_response.item[0].limits.maximum_duration #=> Integer
resp.campaigns_response.item[0].limits.messages_per_second #=> Integer
resp.campaigns_response.item[0].limits.total #=> Integer
resp.campaigns_response.item[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.adm_message.body #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.adm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.adm_message.title #=> String
resp.campaigns_response.item[0].message_configuration.adm_message.url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.apns_message.body #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.apns_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.apns_message.title #=> String
resp.campaigns_response.item[0].message_configuration.apns_message.url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.baidu_message.body #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.baidu_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.baidu_message.title #=> String
resp.campaigns_response.item[0].message_configuration.baidu_message.url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.default_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.default_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.default_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.default_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.default_message.title #=> String
resp.campaigns_response.item[0].message_configuration.default_message.url #=> String
resp.campaigns_response.item[0].message_configuration.email_message.body #=> String
resp.campaigns_response.item[0].message_configuration.email_message.from_address #=> String
resp.campaigns_response.item[0].message_configuration.email_message.html_body #=> String
resp.campaigns_response.item[0].message_configuration.email_message.title #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaigns_response.item[0].message_configuration.gcm_message.body #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_small_icon_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.image_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.json_body #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.media_url #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.raw_content #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.silent_push #=> Boolean
resp.campaigns_response.item[0].message_configuration.gcm_message.time_to_live #=> Integer
resp.campaigns_response.item[0].message_configuration.gcm_message.title #=> String
resp.campaigns_response.item[0].message_configuration.gcm_message.url #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.body #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.campaigns_response.item[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].name #=> String
resp.campaigns_response.item[0].schedule.end_time #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.campaigns_response.item[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.campaigns_response.item[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.campaigns_response.item[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.campaigns_response.item[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.campaigns_response.item[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "EVENT"
resp.campaigns_response.item[0].schedule.is_local_time #=> Boolean
resp.campaigns_response.item[0].schedule.quiet_time.end #=> String
resp.campaigns_response.item[0].schedule.quiet_time.start #=> String
resp.campaigns_response.item[0].schedule.start_time #=> String
resp.campaigns_response.item[0].schedule.timezone #=> String
resp.campaigns_response.item[0].segment_id #=> String
resp.campaigns_response.item[0].segment_version #=> Integer
resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
resp.campaigns_response.item[0].treatment_description #=> String
resp.campaigns_response.item[0].treatment_name #=> String
resp.campaigns_response.item[0].version #=> Integer
resp.campaigns_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetCampaignsResponse)
—
Returns a response object which responds to the following methods:
-
#campaigns_response => Types::CampaignsResponse
-
See Also:
3319 3320 3321 3322 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3319 def get_campaigns(params = {}, options = {}) req = build_request(:get_campaigns, params) req.send_request(options) end |
#get_channels(params = {}) ⇒ Types::GetChannelsResponse
Get all channels.
Examples:
Request syntax with placeholder values
resp = client.get_channels({
application_id: "__string", # required
})
Response structure
resp.channels_response.channels #=> Hash
resp.channels_response.channels["__string"].application_id #=> String
resp.channels_response.channels["__string"].creation_date #=> String
resp.channels_response.channels["__string"].enabled #=> Boolean
resp.channels_response.channels["__string"].has_credential #=> Boolean
resp.channels_response.channels["__string"].id #=> String
resp.channels_response.channels["__string"].is_archived #=> Boolean
resp.channels_response.channels["__string"].last_modified_by #=> String
resp.channels_response.channels["__string"].last_modified_date #=> String
resp.channels_response.channels["__string"].version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetChannelsResponse)
—
Returns a response object which responds to the following methods:
-
#channels_response => Types::ChannelsResponse
-
See Also:
3355 3356 3357 3358 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3355 def get_channels(params = {}, options = {}) req = build_request(:get_channels, params) req.send_request(options) end |
#get_email_channel(params = {}) ⇒ Types::GetEmailChannelResponse
Get an email channel.
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.email_channel_response.from_address #=> String
resp.email_channel_response.has_credential #=> Boolean
resp.email_channel_response.id #=> String
resp.email_channel_response.identity #=> String
resp.email_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetEmailChannelResponse)
—
Returns a response object which responds to the following methods:
-
#email_channel_response => Types::EmailChannelResponse
-
See Also:
3396 3397 3398 3399 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3396 def get_email_channel(params = {}, options = {}) req = build_request(:get_email_channel, params) req.send_request(options) end |
#get_endpoint(params = {}) ⇒ Types::GetEndpointResponse
Returns information about an endpoint.
Examples:
Request syntax with placeholder values
resp = client.get_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 "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :endpoint_id (required, String)
Returns:
-
(Types::GetEndpointResponse)
—
Returns a response object which responds to the following methods:
-
#endpoint_response => Types::EndpointResponse
-
See Also:
3458 3459 3460 3461 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3458 def get_endpoint(params = {}, options = {}) req = build_request(:get_endpoint, params) req.send_request(options) end |
#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse
Returns the event stream for an app.
Examples:
Request syntax with placeholder values
resp = client.get_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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetEventStreamResponse)
—
Returns a response object which responds to the following methods:
-
#event_stream => Types::EventStream
-
See Also:
3490 3491 3492 3493 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3490 def get_event_stream(params = {}, options = {}) req = build_request(:get_event_stream, params) req.send_request(options) end |
#get_export_job(params = {}) ⇒ Types::GetExportJobResponse
Returns information about an export job.
Examples:
Request syntax with placeholder values
resp = client.get_export_job({
application_id: "__string", # required
job_id: "__string", # required
})
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", "INITIALIZING", "PROCESSING", "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :job_id (required, String)
Returns:
-
(Types::GetExportJobResponse)
—
Returns a response object which responds to the following methods:
-
#export_job_response => Types::ExportJobResponse
-
See Also:
3536 3537 3538 3539 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3536 def get_export_job(params = {}, options = {}) req = build_request(:get_export_job, params) req.send_request(options) end |
#get_export_jobs(params = {}) ⇒ Types::GetExportJobsResponse
Returns information about your export jobs.
Examples:
Request syntax with placeholder values
resp = client.get_export_jobs({
application_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.export_jobs_response.item #=> Array
resp.export_jobs_response.item[0].application_id #=> String
resp.export_jobs_response.item[0].completed_pieces #=> Integer
resp.export_jobs_response.item[0].completion_date #=> String
resp.export_jobs_response.item[0].creation_date #=> String
resp.export_jobs_response.item[0].definition.role_arn #=> String
resp.export_jobs_response.item[0].definition.s3_url_prefix #=> String
resp.export_jobs_response.item[0].definition.segment_id #=> String
resp.export_jobs_response.item[0].definition.segment_version #=> Integer
resp.export_jobs_response.item[0].failed_pieces #=> Integer
resp.export_jobs_response.item[0].failures #=> Array
resp.export_jobs_response.item[0].failures[0] #=> String
resp.export_jobs_response.item[0].id #=> String
resp.export_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.export_jobs_response.item[0].total_failures #=> Integer
resp.export_jobs_response.item[0].total_pieces #=> Integer
resp.export_jobs_response.item[0].total_processed #=> Integer
resp.export_jobs_response.item[0].type #=> String
resp.export_jobs_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetExportJobsResponse)
—
Returns a response object which responds to the following methods:
-
#export_jobs_response => Types::ExportJobsResponse
-
See Also:
3587 3588 3589 3590 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3587 def get_export_jobs(params = {}, options = {}) req = build_request(:get_export_jobs, params) req.send_request(options) end |
#get_gcm_channel(params = {}) ⇒ Types::GetGcmChannelResponse
Returns information about the GCM channel for an app.
Examples:
Request syntax with placeholder values
resp = client.get_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 #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.id #=> String
resp.gcm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetGcmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#gcm_channel_response => Types::GCMChannelResponse
-
See Also:
3624 3625 3626 3627 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3624 def get_gcm_channel(params = {}, options = {}) req = build_request(:get_gcm_channel, params) req.send_request(options) end |
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Returns information about an import job.
Examples:
Request syntax with placeholder values
resp = client.get_import_job({
application_id: "__string", # required
job_id: "__string", # required
})
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 #=> Boolean
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 #=> Boolean
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", "INITIALIZING", "PROCESSING", "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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :job_id (required, String)
Returns:
-
(Types::GetImportJobResponse)
—
Returns a response object which responds to the following methods:
-
#import_job_response => Types::ImportJobResponse
-
See Also:
3674 3675 3676 3677 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3674 def get_import_job(params = {}, options = {}) req = build_request(:get_import_job, params) req.send_request(options) end |
#get_import_jobs(params = {}) ⇒ Types::GetImportJobsResponse
Returns information about your import jobs.
Examples:
Request syntax with placeholder values
resp = client.get_import_jobs({
application_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.import_jobs_response.item #=> Array
resp.import_jobs_response.item[0].application_id #=> String
resp.import_jobs_response.item[0].completed_pieces #=> Integer
resp.import_jobs_response.item[0].completion_date #=> String
resp.import_jobs_response.item[0].creation_date #=> String
resp.import_jobs_response.item[0].definition.define_segment #=> Boolean
resp.import_jobs_response.item[0].definition.external_id #=> String
resp.import_jobs_response.item[0].definition.format #=> String, one of "CSV", "JSON"
resp.import_jobs_response.item[0].definition.register_endpoints #=> Boolean
resp.import_jobs_response.item[0].definition.role_arn #=> String
resp.import_jobs_response.item[0].definition.s3_url #=> String
resp.import_jobs_response.item[0].definition.segment_id #=> String
resp.import_jobs_response.item[0].definition.segment_name #=> String
resp.import_jobs_response.item[0].failed_pieces #=> Integer
resp.import_jobs_response.item[0].failures #=> Array
resp.import_jobs_response.item[0].failures[0] #=> String
resp.import_jobs_response.item[0].id #=> String
resp.import_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.import_jobs_response.item[0].total_failures #=> Integer
resp.import_jobs_response.item[0].total_pieces #=> Integer
resp.import_jobs_response.item[0].total_processed #=> Integer
resp.import_jobs_response.item[0].type #=> String
resp.import_jobs_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetImportJobsResponse)
—
Returns a response object which responds to the following methods:
-
#import_jobs_response => Types::ImportJobsResponse
-
See Also:
3729 3730 3731 3732 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3729 def get_import_jobs(params = {}, options = {}) req = build_request(:get_import_jobs, params) req.send_request(options) end |
#get_segment(params = {}) ⇒ Types::GetSegmentResponse
Returns information about a segment.
Examples:
Request syntax with placeholder values
resp = client.get_segment({
application_id: "__string", # required
segment_id: "__string", # required
})
Response structure
resp.segment_response.application_id #=> 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.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :segment_id (required, String)
Returns:
-
(Types::GetSegmentResponse)
—
Returns a response object which responds to the following methods:
-
#segment_response => Types::SegmentResponse
-
See Also:
3854 3855 3856 3857 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3854 def get_segment(params = {}, options = {}) req = build_request(:get_segment, params) req.send_request(options) end |
#get_segment_export_jobs(params = {}) ⇒ Types::GetSegmentExportJobsResponse
Returns a list of export jobs for a specific segment.
Examples:
Request syntax with placeholder values
resp = client.get_segment_export_jobs({
application_id: "__string", # required
page_size: "__string",
segment_id: "__string", # required
token: "__string",
})
Response structure
resp.export_jobs_response.item #=> Array
resp.export_jobs_response.item[0].application_id #=> String
resp.export_jobs_response.item[0].completed_pieces #=> Integer
resp.export_jobs_response.item[0].completion_date #=> String
resp.export_jobs_response.item[0].creation_date #=> String
resp.export_jobs_response.item[0].definition.role_arn #=> String
resp.export_jobs_response.item[0].definition.s3_url_prefix #=> String
resp.export_jobs_response.item[0].definition.segment_id #=> String
resp.export_jobs_response.item[0].definition.segment_version #=> Integer
resp.export_jobs_response.item[0].failed_pieces #=> Integer
resp.export_jobs_response.item[0].failures #=> Array
resp.export_jobs_response.item[0].failures[0] #=> String
resp.export_jobs_response.item[0].id #=> String
resp.export_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.export_jobs_response.item[0].total_failures #=> Integer
resp.export_jobs_response.item[0].total_pieces #=> Integer
resp.export_jobs_response.item[0].total_processed #=> Integer
resp.export_jobs_response.item[0].type #=> String
resp.export_jobs_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :segment_id (required, String)
- :token (String)
Returns:
-
(Types::GetSegmentExportJobsResponse)
—
Returns a response object which responds to the following methods:
-
#export_jobs_response => Types::ExportJobsResponse
-
See Also:
3908 3909 3910 3911 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3908 def get_segment_export_jobs(params = {}, options = {}) req = build_request(:get_segment_export_jobs, params) req.send_request(options) end |
#get_segment_import_jobs(params = {}) ⇒ Types::GetSegmentImportJobsResponse
Returns a list of import jobs for a specific segment.
Examples:
Request syntax with placeholder values
resp = client.get_segment_import_jobs({
application_id: "__string", # required
page_size: "__string",
segment_id: "__string", # required
token: "__string",
})
Response structure
resp.import_jobs_response.item #=> Array
resp.import_jobs_response.item[0].application_id #=> String
resp.import_jobs_response.item[0].completed_pieces #=> Integer
resp.import_jobs_response.item[0].completion_date #=> String
resp.import_jobs_response.item[0].creation_date #=> String
resp.import_jobs_response.item[0].definition.define_segment #=> Boolean
resp.import_jobs_response.item[0].definition.external_id #=> String
resp.import_jobs_response.item[0].definition.format #=> String, one of "CSV", "JSON"
resp.import_jobs_response.item[0].definition.register_endpoints #=> Boolean
resp.import_jobs_response.item[0].definition.role_arn #=> String
resp.import_jobs_response.item[0].definition.s3_url #=> String
resp.import_jobs_response.item[0].definition.segment_id #=> String
resp.import_jobs_response.item[0].definition.segment_name #=> String
resp.import_jobs_response.item[0].failed_pieces #=> Integer
resp.import_jobs_response.item[0].failures #=> Array
resp.import_jobs_response.item[0].failures[0] #=> String
resp.import_jobs_response.item[0].id #=> String
resp.import_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.import_jobs_response.item[0].total_failures #=> Integer
resp.import_jobs_response.item[0].total_pieces #=> Integer
resp.import_jobs_response.item[0].total_processed #=> Integer
resp.import_jobs_response.item[0].type #=> String
resp.import_jobs_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :segment_id (required, String)
- :token (String)
Returns:
-
(Types::GetSegmentImportJobsResponse)
—
Returns a response object which responds to the following methods:
-
#import_jobs_response => Types::ImportJobsResponse
-
See Also:
3966 3967 3968 3969 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 3966 def get_segment_import_jobs(params = {}, options = {}) req = build_request(:get_segment_import_jobs, params) req.send_request(options) end |
#get_segment_version(params = {}) ⇒ Types::GetSegmentVersionResponse
Returns information about a segment version.
Examples:
Request syntax with placeholder values
resp = client.get_segment_version({
application_id: "__string", # required
segment_id: "__string", # required
version: "__string", # required
})
Response structure
resp.segment_response.application_id #=> 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.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :segment_id (required, String)
- :version (required, String)
Returns:
-
(Types::GetSegmentVersionResponse)
—
Returns a response object which responds to the following methods:
-
#segment_response => Types::SegmentResponse
-
See Also:
4094 4095 4096 4097 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4094 def get_segment_version(params = {}, options = {}) req = build_request(:get_segment_version, params) req.send_request(options) end |
#get_segment_versions(params = {}) ⇒ Types::GetSegmentVersionsResponse
Returns information about your segment versions.
Examples:
Request syntax with placeholder values
resp = client.get_segment_versions({
application_id: "__string", # required
page_size: "__string",
segment_id: "__string", # required
token: "__string",
})
Response structure
resp.segments_response.item #=> Array
resp.segments_response.item[0].application_id #=> String
resp.segments_response.item[0].creation_date #=> String
resp.segments_response.item[0].dimensions.attributes #=> Hash
resp.segments_response.item[0].dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.attributes["__string"].values #=> Array
resp.segments_response.item[0].dimensions.attributes["__string"].values[0] #=> String
resp.segments_response.item[0].dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segments_response.item[0].dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segments_response.item[0].dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.app_version.values #=> Array
resp.segments_response.item[0].dimensions.demographic.app_version.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.channel.values #=> Array
resp.segments_response.item[0].dimensions.demographic.channel.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.device_type.values #=> Array
resp.segments_response.item[0].dimensions.demographic.device_type.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.make.values #=> Array
resp.segments_response.item[0].dimensions.demographic.make.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.model.values #=> Array
resp.segments_response.item[0].dimensions.demographic.model.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.platform.values #=> Array
resp.segments_response.item[0].dimensions.demographic.platform.values[0] #=> String
resp.segments_response.item[0].dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.location.country.values #=> Array
resp.segments_response.item[0].dimensions.location.country.values[0] #=> String
resp.segments_response.item[0].dimensions.location.gps_point.coordinates.latitude #=> Float
resp.segments_response.item[0].dimensions.location.gps_point.coordinates.longitude #=> Float
resp.segments_response.item[0].dimensions.location.gps_point.range_in_kilometers #=> Float
resp.segments_response.item[0].dimensions.metrics #=> Hash
resp.segments_response.item[0].dimensions.metrics["__string"].comparison_operator #=> String
resp.segments_response.item[0].dimensions.metrics["__string"].value #=> Float
resp.segments_response.item[0].dimensions.user_attributes #=> Hash
resp.segments_response.item[0].dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.user_attributes["__string"].values #=> Array
resp.segments_response.item[0].dimensions.user_attributes["__string"].values[0] #=> String
resp.segments_response.item[0].id #=> String
resp.segments_response.item[0].import_definition.channel_counts #=> Hash
resp.segments_response.item[0].import_definition.channel_counts["__string"] #=> Integer
resp.segments_response.item[0].import_definition.external_id #=> String
resp.segments_response.item[0].import_definition.format #=> String, one of "CSV", "JSON"
resp.segments_response.item[0].import_definition.role_arn #=> String
resp.segments_response.item[0].import_definition.s3_url #=> String
resp.segments_response.item[0].import_definition.size #=> Integer
resp.segments_response.item[0].last_modified_date #=> String
resp.segments_response.item[0].name #=> String
resp.segments_response.item[0].segment_groups.groups #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.latitude #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.longitude #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.range_in_kilometers #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics["__string"].comparison_operator #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics["__string"].value #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].source_segments #=> Array
resp.segments_response.item[0].segment_groups.groups[0].source_segments[0].id #=> String
resp.segments_response.item[0].segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segments_response.item[0].segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segments_response.item[0].version #=> Integer
resp.segments_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :segment_id (required, String)
- :token (String)
Returns:
-
(Types::GetSegmentVersionsResponse)
—
Returns a response object which responds to the following methods:
-
#segments_response => Types::SegmentsResponse
-
See Also:
4227 4228 4229 4230 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4227 def get_segment_versions(params = {}, options = {}) req = build_request(:get_segment_versions, params) req.send_request(options) end |
#get_segments(params = {}) ⇒ Types::GetSegmentsResponse
Used to get information about your segments.
Examples:
Request syntax with placeholder values
resp = client.get_segments({
application_id: "__string", # required
page_size: "__string",
token: "__string",
})
Response structure
resp.segments_response.item #=> Array
resp.segments_response.item[0].application_id #=> String
resp.segments_response.item[0].creation_date #=> String
resp.segments_response.item[0].dimensions.attributes #=> Hash
resp.segments_response.item[0].dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.attributes["__string"].values #=> Array
resp.segments_response.item[0].dimensions.attributes["__string"].values[0] #=> String
resp.segments_response.item[0].dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segments_response.item[0].dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segments_response.item[0].dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.app_version.values #=> Array
resp.segments_response.item[0].dimensions.demographic.app_version.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.channel.values #=> Array
resp.segments_response.item[0].dimensions.demographic.channel.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.device_type.values #=> Array
resp.segments_response.item[0].dimensions.demographic.device_type.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.make.values #=> Array
resp.segments_response.item[0].dimensions.demographic.make.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.model.values #=> Array
resp.segments_response.item[0].dimensions.demographic.model.values[0] #=> String
resp.segments_response.item[0].dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.demographic.platform.values #=> Array
resp.segments_response.item[0].dimensions.demographic.platform.values[0] #=> String
resp.segments_response.item[0].dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.location.country.values #=> Array
resp.segments_response.item[0].dimensions.location.country.values[0] #=> String
resp.segments_response.item[0].dimensions.location.gps_point.coordinates.latitude #=> Float
resp.segments_response.item[0].dimensions.location.gps_point.coordinates.longitude #=> Float
resp.segments_response.item[0].dimensions.location.gps_point.range_in_kilometers #=> Float
resp.segments_response.item[0].dimensions.metrics #=> Hash
resp.segments_response.item[0].dimensions.metrics["__string"].comparison_operator #=> String
resp.segments_response.item[0].dimensions.metrics["__string"].value #=> Float
resp.segments_response.item[0].dimensions.user_attributes #=> Hash
resp.segments_response.item[0].dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].dimensions.user_attributes["__string"].values #=> Array
resp.segments_response.item[0].dimensions.user_attributes["__string"].values[0] #=> String
resp.segments_response.item[0].id #=> String
resp.segments_response.item[0].import_definition.channel_counts #=> Hash
resp.segments_response.item[0].import_definition.channel_counts["__string"] #=> Integer
resp.segments_response.item[0].import_definition.external_id #=> String
resp.segments_response.item[0].import_definition.format #=> String, one of "CSV", "JSON"
resp.segments_response.item[0].import_definition.role_arn #=> String
resp.segments_response.item[0].import_definition.s3_url #=> String
resp.segments_response.item[0].import_definition.size #=> Integer
resp.segments_response.item[0].last_modified_date #=> String
resp.segments_response.item[0].name #=> String
resp.segments_response.item[0].segment_groups.groups #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].attributes["__string"].values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.app_version.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.channel.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.device_type.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.make.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.model.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].demographic.platform.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.country.values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.latitude #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.coordinates.longitude #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].location.gps_point.range_in_kilometers #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics["__string"].comparison_operator #=> String
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].metrics["__string"].value #=> Float
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes #=> Hash
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segments_response.item[0].segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segments_response.item[0].segment_groups.groups[0].source_segments #=> Array
resp.segments_response.item[0].segment_groups.groups[0].source_segments[0].id #=> String
resp.segments_response.item[0].segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segments_response.item[0].segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segments_response.item[0].segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segments_response.item[0].version #=> Integer
resp.segments_response.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :page_size (String)
- :token (String)
Returns:
-
(Types::GetSegmentsResponse)
—
Returns a response object which responds to the following methods:
-
#segments_response => Types::SegmentsResponse
-
See Also:
4357 4358 4359 4360 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4357 def get_segments(params = {}, options = {}) req = build_request(:get_segments, params) req.send_request(options) end |
#get_sms_channel(params = {}) ⇒ Types::GetSmsChannelResponse
Get an SMS channel.
Examples:
Request syntax with placeholder values
resp = client.get_sms_channel({
application_id: "__string", # required
})
Response structure
resp.sms_channel_response.application_id #=> String
resp.sms_channel_response.creation_date #=> String
resp.sms_channel_response.enabled #=> Boolean
resp.sms_channel_response.has_credential #=> Boolean
resp.sms_channel_response.id #=> String
resp.sms_channel_response.is_archived #=> Boolean
resp.sms_channel_response.last_modified_by #=> String
resp.sms_channel_response.last_modified_date #=> String
resp.sms_channel_response.platform #=> String
resp.sms_channel_response.promotional_messages_per_second #=> Integer
resp.sms_channel_response.sender_id #=> String
resp.sms_channel_response.short_code #=> String
resp.sms_channel_response.transactional_messages_per_second #=> Integer
resp.sms_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetSmsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#sms_channel_response => Types::SMSChannelResponse
-
See Also:
4397 4398 4399 4400 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4397 def get_sms_channel(params = {}, options = {}) req = build_request(:get_sms_channel, params) req.send_request(options) end |
#get_user_endpoints(params = {}) ⇒ Types::GetUserEndpointsResponse
Returns information about the endpoints that are associated with a User ID.
Examples:
Request syntax with placeholder values
resp = client.get_user_endpoints({
application_id: "__string", # required
user_id: "__string", # required
})
Response structure
resp.endpoints_response.item #=> Array
resp.endpoints_response.item[0].address #=> String
resp.endpoints_response.item[0].application_id #=> String
resp.endpoints_response.item[0].attributes #=> Hash
resp.endpoints_response.item[0].attributes["__string"] #=> Array
resp.endpoints_response.item[0].attributes["__string"][0] #=> String
resp.endpoints_response.item[0].channel_type #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
resp.endpoints_response.item[0].cohort_id #=> String
resp.endpoints_response.item[0].creation_date #=> String
resp.endpoints_response.item[0].demographic.app_version #=> String
resp.endpoints_response.item[0].demographic.locale #=> String
resp.endpoints_response.item[0].demographic.make #=> String
resp.endpoints_response.item[0].demographic.model #=> String
resp.endpoints_response.item[0].demographic.model_version #=> String
resp.endpoints_response.item[0].demographic.platform #=> String
resp.endpoints_response.item[0].demographic.platform_version #=> String
resp.endpoints_response.item[0].demographic.timezone #=> String
resp.endpoints_response.item[0].effective_date #=> String
resp.endpoints_response.item[0].endpoint_status #=> String
resp.endpoints_response.item[0].id #=> String
resp.endpoints_response.item[0].location.city #=> String
resp.endpoints_response.item[0].location.country #=> String
resp.endpoints_response.item[0].location.latitude #=> Float
resp.endpoints_response.item[0].location.longitude #=> Float
resp.endpoints_response.item[0].location.postal_code #=> String
resp.endpoints_response.item[0].location.region #=> String
resp.endpoints_response.item[0].metrics #=> Hash
resp.endpoints_response.item[0].metrics["__string"] #=> Float
resp.endpoints_response.item[0].opt_out #=> String
resp.endpoints_response.item[0].request_id #=> String
resp.endpoints_response.item[0].user.user_attributes #=> Hash
resp.endpoints_response.item[0].user.user_attributes["__string"] #=> Array
resp.endpoints_response.item[0].user.user_attributes["__string"][0] #=> String
resp.endpoints_response.item[0].user.user_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :user_id (required, String)
Returns:
-
(Types::GetUserEndpointsResponse)
—
Returns a response object which responds to the following methods:
-
#endpoints_response => Types::EndpointsResponse
-
See Also:
4461 4462 4463 4464 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4461 def get_user_endpoints(params = {}, options = {}) req = build_request(:get_user_endpoints, params) req.send_request(options) end |
#get_voice_channel(params = {}) ⇒ Types::GetVoiceChannelResponse
Get a Voice Channel
Examples:
Request syntax with placeholder values
resp = client.get_voice_channel({
application_id: "__string", # required
})
Response structure
resp.voice_channel_response.application_id #=> String
resp.voice_channel_response.creation_date #=> String
resp.voice_channel_response.enabled #=> Boolean
resp.voice_channel_response.has_credential #=> Boolean
resp.voice_channel_response.id #=> String
resp.voice_channel_response.is_archived #=> Boolean
resp.voice_channel_response.last_modified_by #=> String
resp.voice_channel_response.last_modified_date #=> String
resp.voice_channel_response.platform #=> String
resp.voice_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
Returns:
-
(Types::GetVoiceChannelResponse)
—
Returns a response object which responds to the following methods:
-
#voice_channel_response => Types::VoiceChannelResponse
-
See Also:
4497 4498 4499 4500 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4497 def get_voice_channel(params = {}, options = {}) req = build_request(:get_voice_channel, params) req.send_request(options) end |
#phone_number_validate(params = {}) ⇒ Types::PhoneNumberValidateResponse
Returns information about the specified phone number.
Examples:
Request syntax with placeholder values
resp = client.phone_number_validate({
number_validate_request: { # required
iso_country_code: "__string",
phone_number: "__string",
},
})
Response structure
resp.number_validate_response.carrier #=> String
resp.number_validate_response.city #=> String
resp.number_validate_response.cleansed_phone_number_e164 #=> String
resp.number_validate_response.cleansed_phone_number_national #=> String
resp.number_validate_response.country #=> String
resp.number_validate_response.country_code_iso_2 #=> String
resp.number_validate_response.country_code_numeric #=> String
resp.number_validate_response.county #=> String
resp.number_validate_response.original_country_code_iso_2 #=> String
resp.number_validate_response.original_phone_number #=> String
resp.number_validate_response.phone_type #=> String
resp.number_validate_response.phone_type_code #=> Integer
resp.number_validate_response.timezone #=> String
resp.number_validate_response.zip_code #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:number_validate_request
(required, Types::NumberValidateRequest)
—
Phone Number Validate request.
Returns:
-
(Types::PhoneNumberValidateResponse)
—
Returns a response object which responds to the following methods:
-
#number_validate_response => Types::NumberValidateResponse
-
See Also:
4541 4542 4543 4544 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4541 def phone_number_validate(params = {}, options = {}) req = build_request(:phone_number_validate, params) req.send_request(options) end |
#put_event_stream(params = {}) ⇒ Types::PutEventStreamResponse
Use to create or update the event stream for an app.
Examples:
Request syntax with placeholder values
resp = client.put_event_stream({
application_id: "__string", # required
write_event_stream: { # required
destination_stream_arn: "__string",
role_arn: "__string",
},
})
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:write_event_stream
(required, Types::WriteEventStream)
—
Request to save an EventStream.
Returns:
-
(Types::PutEventStreamResponse)
—
Returns a response object which responds to the following methods:
-
#event_stream => Types::EventStream
-
See Also:
4580 4581 4582 4583 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4580 def put_event_stream(params = {}, options = {}) req = build_request(:put_event_stream, params) req.send_request(options) end |
#put_events(params = {}) ⇒ Types::PutEventsResponse
Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.
Examples:
Request syntax with placeholder values
resp = client.put_events({
application_id: "__string", # required
events_request: { # required
batch_item: {
"__string" => {
endpoint: {
address: "__string",
attributes: {
"__string" => ["__string"],
},
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
demographic: {
app_version: "__string",
locale: "__string",
make: "__string",
model: "__string",
model_version: "__string",
platform: "__string",
platform_version: "__string",
timezone: "__string",
},
effective_date: "__string",
endpoint_status: "__string",
location: {
city: "__string",
country: "__string",
latitude: 1.0,
longitude: 1.0,
postal_code: "__string",
region: "__string",
},
metrics: {
"__string" => 1.0,
},
opt_out: "__string",
request_id: "__string",
user: {
user_attributes: {
"__string" => ["__string"],
},
user_id: "__string",
},
},
events: {
"__string" => {
attributes: {
"__string" => "__string",
},
client_sdk_version: "__string",
event_type: "__string",
metrics: {
"__string" => 1.0,
},
session: {
duration: 1,
id: "__string",
start_timestamp: "__string",
stop_timestamp: "__string",
},
timestamp: "__string",
},
},
},
},
},
})
Response structure
resp.events_response.results #=> Hash
resp.events_response.results["__string"].endpoint_item_response.message #=> String
resp.events_response.results["__string"].endpoint_item_response.status_code #=> Integer
resp.events_response.results["__string"].events_item_response #=> Hash
resp.events_response.results["__string"].events_item_response["__string"].message #=> String
resp.events_response.results["__string"].events_item_response["__string"].status_code #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:events_request
(required, Types::EventsRequest)
—
A set of events to process.
Returns:
-
(Types::PutEventsResponse)
—
Returns a response object which responds to the following methods:
-
#events_response => Types::EventsResponse
-
See Also:
4680 4681 4682 4683 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4680 def put_events(params = {}, options = {}) req = build_request(:put_events, params) req.send_request(options) end |
#remove_attributes(params = {}) ⇒ Types::RemoveAttributesResponse
Used to remove the attributes for an app
Examples:
Request syntax with placeholder values
resp = client.remove_attributes({
application_id: "__string", # required
attribute_type: "__string", # required
update_attributes_request: { # required
blacklist: ["__string"],
},
})
Response structure
resp.attributes_resource.application_id #=> String
resp.attributes_resource.attribute_type #=> String
resp.attributes_resource.attributes #=> Array
resp.attributes_resource.attributes[0] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :attribute_type (required, String)
-
:update_attributes_request
(required, Types::UpdateAttributesRequest)
—
Update attributes request
Returns:
-
(Types::RemoveAttributesResponse)
—
Returns a response object which responds to the following methods:
-
#attributes_resource => Types::AttributesResource
-
See Also:
4719 4720 4721 4722 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4719 def remove_attributes(params = {}, options = {}) req = build_request(:remove_attributes, params) req.send_request(options) end |
#send_messages(params = {}) ⇒ Types::SendMessagesResponse
Used to send a direct message.
Examples:
Request syntax with placeholder values
resp = client.send_messages({
application_id: "__string", # required
message_request: { # required
addresses: {
"__string" => {
body_override: "__string",
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
},
},
context: {
"__string" => "__string",
},
endpoints: {
"__string" => {
body_override: "__string",
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
},
},
message_configuration: {
adm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
consolidation_key: "__string",
data: {
"__string" => "__string",
},
expires_after: "__string",
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
md5: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
apns_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
badge: 1,
body: "__string",
category: "__string",
collapse_id: "__string",
data: {
"__string" => "__string",
},
media_url: "__string",
preferred_authentication_method: "__string",
priority: "__string",
raw_content: "__string",
silent_push: false,
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
thread_id: "__string",
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
default_message: {
body: "__string",
substitutions: {
"__string" => ["__string"],
},
},
default_push_notification_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
silent_push: false,
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
email_message: {
body: "__string",
feedback_forwarding_address: "__string",
from_address: "__string",
raw_email: {
data: "data",
},
reply_to_addresses: ["__string"],
simple_email: {
html_part: {
charset: "__string",
data: "__string",
},
subject: {
charset: "__string",
data: "__string",
},
text_part: {
charset: "__string",
data: "__string",
},
},
substitutions: {
"__string" => ["__string"],
},
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
collapse_key: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
priority: "__string",
raw_content: "__string",
restricted_package_name: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
keyword: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
origination_number: "__string",
sender_id: "__string",
substitutions: {
"__string" => ["__string"],
},
},
voice_message: {
body: "__string",
language_code: "__string",
origination_number: "__string",
substitutions: {
"__string" => ["__string"],
},
voice_id: "__string",
},
},
trace_id: "__string",
},
})
Response structure
resp.message_response.application_id #=> String
resp.message_response.endpoint_result #=> Hash
resp.message_response.endpoint_result["__string"].address #=> String
resp.message_response.endpoint_result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
resp.message_response.endpoint_result["__string"].message_id #=> String
resp.message_response.endpoint_result["__string"].status_code #=> Integer
resp.message_response.endpoint_result["__string"].status_message #=> String
resp.message_response.endpoint_result["__string"].updated_token #=> String
resp.message_response.request_id #=> String
resp.message_response.result #=> Hash
resp.message_response.result["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
resp.message_response.result["__string"].message_id #=> String
resp.message_response.result["__string"].status_code #=> Integer
resp.message_response.result["__string"].status_message #=> String
resp.message_response.result["__string"].updated_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:message_request
(required, Types::MessageRequest)
—
Send message request.
Returns:
-
(Types::SendMessagesResponse)
—
Returns a response object which responds to the following methods:
-
#message_response => Types::MessageResponse
-
See Also:
4950 4951 4952 4953 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 4950 def send_messages(params = {}, options = {}) req = build_request(:send_messages, params) req.send_request(options) end |
#send_users_messages(params = {}) ⇒ Types::SendUsersMessagesResponse
Used to send a message to a list of users.
Examples:
Request syntax with placeholder values
resp = client.send_users_messages({
application_id: "__string", # required
send_users_message_request: { # required
context: {
"__string" => "__string",
},
message_configuration: {
adm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
consolidation_key: "__string",
data: {
"__string" => "__string",
},
expires_after: "__string",
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
md5: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
apns_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
badge: 1,
body: "__string",
category: "__string",
collapse_id: "__string",
data: {
"__string" => "__string",
},
media_url: "__string",
preferred_authentication_method: "__string",
priority: "__string",
raw_content: "__string",
silent_push: false,
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
thread_id: "__string",
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
default_message: {
body: "__string",
substitutions: {
"__string" => ["__string"],
},
},
default_push_notification_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
silent_push: false,
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
email_message: {
body: "__string",
feedback_forwarding_address: "__string",
from_address: "__string",
raw_email: {
data: "data",
},
reply_to_addresses: ["__string"],
simple_email: {
html_part: {
charset: "__string",
data: "__string",
},
subject: {
charset: "__string",
data: "__string",
},
text_part: {
charset: "__string",
data: "__string",
},
},
substitutions: {
"__string" => ["__string"],
},
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
collapse_key: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
priority: "__string",
raw_content: "__string",
restricted_package_name: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
keyword: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
origination_number: "__string",
sender_id: "__string",
substitutions: {
"__string" => ["__string"],
},
},
voice_message: {
body: "__string",
language_code: "__string",
origination_number: "__string",
substitutions: {
"__string" => ["__string"],
},
voice_id: "__string",
},
},
trace_id: "__string",
users: {
"__string" => {
body_override: "__string",
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
},
},
},
})
Response structure
resp.send_users_message_response.application_id #=> String
resp.send_users_message_response.request_id #=> String
resp.send_users_message_response.result #=> Hash
resp.send_users_message_response.result["__string"] #=> Hash
resp.send_users_message_response.result["__string"]["__string"].address #=> String
resp.send_users_message_response.result["__string"]["__string"].delivery_status #=> String, one of "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE"
resp.send_users_message_response.result["__string"]["__string"].message_id #=> String
resp.send_users_message_response.result["__string"]["__string"].status_code #=> Integer
resp.send_users_message_response.result["__string"]["__string"].status_message #=> String
resp.send_users_message_response.result["__string"]["__string"].updated_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:send_users_message_request
(required, Types::SendUsersMessageRequest)
—
Send message request.
Returns:
-
(Types::SendUsersMessagesResponse)
—
Returns a response object which responds to the following methods:
-
#send_users_message_response => Types::SendUsersMessageResponse
-
See Also:
5162 5163 5164 5165 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5162 def send_users_messages(params = {}, options = {}) req = build_request(:send_users_messages, params) req.send_request(options) end |
#update_adm_channel(params = {}) ⇒ Types::UpdateAdmChannelResponse
Update an ADM channel.
Examples:
Request syntax with placeholder values
resp = client.update_adm_channel({
adm_channel_request: { # required
client_id: "__string",
client_secret: "__string",
enabled: false,
},
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 #=> Boolean
resp.adm_channel_response.has_credential #=> Boolean
resp.adm_channel_response.id #=> String
resp.adm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:adm_channel_request
(required, Types::ADMChannelRequest)
—
Amazon Device Messaging channel definition.
- :application_id (required, String)
Returns:
-
(Types::UpdateAdmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#adm_channel_response => Types::ADMChannelResponse
-
See Also:
5206 5207 5208 5209 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5206 def update_adm_channel(params = {}, options = {}) req = build_request(:update_adm_channel, params) req.send_request(options) end |
#update_apns_channel(params = {}) ⇒ Types::UpdateApnsChannelResponse
Use to update the APNs channel for an app.
Examples:
Request syntax with placeholder values
resp = client.update_apns_channel({
apns_channel_request: { # required
bundle_id: "__string",
certificate: "__string",
default_authentication_method: "__string",
enabled: false,
private_key: "__string",
team_id: "__string",
token_key: "__string",
token_key_id: "__string",
},
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 #=> Boolean
resp.apns_channel_response.has_credential #=> Boolean
resp.apns_channel_response.has_token_key #=> Boolean
resp.apns_channel_response.id #=> String
resp.apns_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:apns_channel_request
(required, Types::APNSChannelRequest)
—
Apple Push Notification Service channel definition.
- :application_id (required, String)
Returns:
-
(Types::UpdateApnsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_channel_response => Types::APNSChannelResponse
-
See Also:
5257 5258 5259 5260 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5257 def update_apns_channel(params = {}, options = {}) req = build_request(:update_apns_channel, params) req.send_request(options) end |
#update_apns_sandbox_channel(params = {}) ⇒ Types::UpdateApnsSandboxChannelResponse
Update an APNS sandbox channel.
Examples:
Request syntax with placeholder values
resp = client.update_apns_sandbox_channel({
apns_sandbox_channel_request: { # required
bundle_id: "__string",
certificate: "__string",
default_authentication_method: "__string",
enabled: false,
private_key: "__string",
team_id: "__string",
token_key: "__string",
token_key_id: "__string",
},
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 #=> Boolean
resp.apns_sandbox_channel_response.has_credential #=> Boolean
resp.apns_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_sandbox_channel_response.id #=> String
resp.apns_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:apns_sandbox_channel_request
(required, Types::APNSSandboxChannelRequest)
—
Apple Development Push Notification Service channel definition.
- :application_id (required, String)
Returns:
-
(Types::UpdateApnsSandboxChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_sandbox_channel_response => Types::APNSSandboxChannelResponse
-
See Also:
5308 5309 5310 5311 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5308 def update_apns_sandbox_channel(params = {}, options = {}) req = build_request(:update_apns_sandbox_channel, params) req.send_request(options) end |
#update_apns_voip_channel(params = {}) ⇒ Types::UpdateApnsVoipChannelResponse
Update an APNS VoIP channel
Examples:
Request syntax with placeholder values
resp = client.update_apns_voip_channel({
apns_voip_channel_request: { # required
bundle_id: "__string",
certificate: "__string",
default_authentication_method: "__string",
enabled: false,
private_key: "__string",
team_id: "__string",
token_key: "__string",
token_key_id: "__string",
},
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 #=> Boolean
resp.apns_voip_channel_response.has_credential #=> Boolean
resp.apns_voip_channel_response.has_token_key #=> Boolean
resp.apns_voip_channel_response.id #=> String
resp.apns_voip_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:apns_voip_channel_request
(required, Types::APNSVoipChannelRequest)
—
Apple VoIP Push Notification Service channel definition.
- :application_id (required, String)
Returns:
-
(Types::UpdateApnsVoipChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_voip_channel_response => Types::APNSVoipChannelResponse
-
See Also:
5359 5360 5361 5362 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5359 def update_apns_voip_channel(params = {}, options = {}) req = build_request(:update_apns_voip_channel, params) req.send_request(options) end |
#update_apns_voip_sandbox_channel(params = {}) ⇒ Types::UpdateApnsVoipSandboxChannelResponse
Update an APNS VoIP sandbox channel
Examples:
Request syntax with placeholder values
resp = client.update_apns_voip_sandbox_channel({
apns_voip_sandbox_channel_request: { # required
bundle_id: "__string",
certificate: "__string",
default_authentication_method: "__string",
enabled: false,
private_key: "__string",
team_id: "__string",
token_key: "__string",
token_key_id: "__string",
},
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 #=> Boolean
resp.apns_voip_sandbox_channel_response.has_credential #=> Boolean
resp.apns_voip_sandbox_channel_response.has_token_key #=> Boolean
resp.apns_voip_sandbox_channel_response.id #=> String
resp.apns_voip_sandbox_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:apns_voip_sandbox_channel_request
(required, Types::APNSVoipSandboxChannelRequest)
—
Apple VoIP Developer Push Notification Service channel definition.
- :application_id (required, String)
Returns:
-
(Types::UpdateApnsVoipSandboxChannelResponse)
—
Returns a response object which responds to the following methods:
-
#apns_voip_sandbox_channel_response => Types::APNSVoipSandboxChannelResponse
-
See Also:
5410 5411 5412 5413 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5410 def update_apns_voip_sandbox_channel(params = {}, options = {}) req = build_request(:update_apns_voip_sandbox_channel, params) req.send_request(options) end |
#update_application_settings(params = {}) ⇒ Types::UpdateApplicationSettingsResponse
Used to update the settings for an app.
Examples:
Request syntax with placeholder values
resp = client.update_application_settings({
application_id: "__string", # required
write_application_settings_request: { # required
campaign_hook: {
lambda_function_name: "__string",
mode: "DELIVERY", # accepts DELIVERY, FILTER
web_url: "__string",
},
cloud_watch_metrics_enabled: false,
limits: {
daily: 1,
maximum_duration: 1,
messages_per_second: 1,
total: 1,
},
quiet_time: {
end: "__string",
start: "__string",
},
},
})
Response structure
resp.application_settings_resource.application_id #=> String
resp.application_settings_resource.campaign_hook.lambda_function_name #=> String
resp.application_settings_resource.campaign_hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.application_settings_resource.campaign_hook.web_url #=> String
resp.application_settings_resource.last_modified_date #=> String
resp.application_settings_resource.limits.daily #=> Integer
resp.application_settings_resource.limits.maximum_duration #=> Integer
resp.application_settings_resource.limits.messages_per_second #=> Integer
resp.application_settings_resource.limits.total #=> Integer
resp.application_settings_resource.quiet_time.end #=> String
resp.application_settings_resource.quiet_time.start #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:write_application_settings_request
(required, Types::WriteApplicationSettingsRequest)
—
Creating application setting request
Returns:
-
(Types::UpdateApplicationSettingsResponse)
—
Returns a response object which responds to the following methods:
-
#application_settings_resource => Types::ApplicationSettingsResource
-
See Also:
5468 5469 5470 5471 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5468 def update_application_settings(params = {}, options = {}) req = build_request(:update_application_settings, params) req.send_request(options) end |
#update_baidu_channel(params = {}) ⇒ Types::UpdateBaiduChannelResponse
Update a BAIDU GCM channel
Examples:
Request syntax with placeholder values
resp = client.update_baidu_channel({
application_id: "__string", # required
baidu_channel_request: { # required
api_key: "__string",
enabled: false,
secret_key: "__string",
},
})
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 #=> Boolean
resp.baidu_channel_response.has_credential #=> Boolean
resp.baidu_channel_response.id #=> String
resp.baidu_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:baidu_channel_request
(required, Types::BaiduChannelRequest)
—
Baidu Cloud Push credentials
Returns:
-
(Types::UpdateBaiduChannelResponse)
—
Returns a response object which responds to the following methods:
-
#baidu_channel_response => Types::BaiduChannelResponse
-
See Also:
5513 5514 5515 5516 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 5513 def update_baidu_channel(params = {}, options = {}) req = build_request(:update_baidu_channel, params) req.send_request(options) end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Use to update a campaign.
Examples:
Request syntax with placeholder values
resp = client.update_campaign({
application_id: "__string", # required
campaign_id: "__string", # required
write_campaign_request: { # required
additional_treatments: [
{
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",
},
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: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # 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",
timezone: "__string",
},
size_percent: 1,
treatment_description: "__string",
treatment_name: "__string",
},
],
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",
},
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: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # 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",
timezone: "__string",
},
segment_id: "__string",
segment_version: 1,
treatment_description: "__string",
treatment_name: "__string",
},
})
Response structure
resp.campaign_response.additional_treatments #=> Array
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
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.creation_date #=> String
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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"
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :campaign_id (required, String)
-
:write_campaign_request
(required, Types::WriteCampaignRequest)
—
Used to create a campaign.
Returns:
-
(Types::UpdateCampaignResponse)
—
Returns a response object which responds to the following methods:
-
#campaign_response => Types::CampaignResponse
-
See Also:
6001 6002 6003 6004 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6001 def update_campaign(params = {}, options = {}) req = build_request(:update_campaign, params) req.send_request(options) end |
#update_email_channel(params = {}) ⇒ Types::UpdateEmailChannelResponse
Update an email channel.
Examples:
Request syntax with placeholder values
resp = client.update_email_channel({
application_id: "__string", # required
email_channel_request: { # required
configuration_set: "__string",
enabled: false,
from_address: "__string",
identity: "__string",
role_arn: "__string",
},
})
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 #=> Boolean
resp.email_channel_response.from_address #=> String
resp.email_channel_response.has_credential #=> Boolean
resp.email_channel_response.id #=> String
resp.email_channel_response.identity #=> String
resp.email_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:email_channel_request
(required, Types::EmailChannelRequest)
—
Email Channel Request
Returns:
-
(Types::UpdateEmailChannelResponse)
—
Returns a response object which responds to the following methods:
-
#email_channel_response => Types::EmailChannelResponse
-
See Also:
6052 6053 6054 6055 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6052 def update_email_channel(params = {}, options = {}) req = build_request(:update_email_channel, params) req.send_request(options) end |
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse
Creates or updates an endpoint.
Examples:
Request syntax with placeholder values
resp = client.update_endpoint({
application_id: "__string", # required
endpoint_id: "__string", # required
endpoint_request: { # required
address: "__string",
attributes: {
"__string" => ["__string"],
},
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
demographic: {
app_version: "__string",
locale: "__string",
make: "__string",
model: "__string",
model_version: "__string",
platform: "__string",
platform_version: "__string",
timezone: "__string",
},
effective_date: "__string",
endpoint_status: "__string",
location: {
city: "__string",
country: "__string",
latitude: 1.0,
longitude: 1.0,
postal_code: "__string",
region: "__string",
},
metrics: {
"__string" => 1.0,
},
opt_out: "__string",
request_id: "__string",
user: {
user_attributes: {
"__string" => ["__string"],
},
user_id: "__string",
},
},
})
Response structure
resp.message_body.message #=> String
resp.message_body.request_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :endpoint_id (required, String)
-
:endpoint_request
(required, Types::EndpointRequest)
—
An endpoint update request.
Returns:
-
(Types::UpdateEndpointResponse)
—
Returns a response object which responds to the following methods:
-
#message_body => Types::MessageBody
-
See Also:
6124 6125 6126 6127 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6124 def update_endpoint(params = {}, options = {}) req = build_request(:update_endpoint, params) req.send_request(options) end |
#update_endpoints_batch(params = {}) ⇒ Types::UpdateEndpointsBatchResponse
Use to update a batch of endpoints.
Examples:
Request syntax with placeholder values
resp = client.update_endpoints_batch({
application_id: "__string", # required
endpoint_batch_request: { # required
item: [
{
address: "__string",
attributes: {
"__string" => ["__string"],
},
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
demographic: {
app_version: "__string",
locale: "__string",
make: "__string",
model: "__string",
model_version: "__string",
platform: "__string",
platform_version: "__string",
timezone: "__string",
},
effective_date: "__string",
endpoint_status: "__string",
id: "__string",
location: {
city: "__string",
country: "__string",
latitude: 1.0,
longitude: 1.0,
postal_code: "__string",
region: "__string",
},
metrics: {
"__string" => 1.0,
},
opt_out: "__string",
request_id: "__string",
user: {
user_attributes: {
"__string" => ["__string"],
},
user_id: "__string",
},
},
],
},
})
Response structure
resp.message_body.message #=> String
resp.message_body.request_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:endpoint_batch_request
(required, Types::EndpointBatchRequest)
—
Endpoint batch update request.
Returns:
-
(Types::UpdateEndpointsBatchResponse)
—
Returns a response object which responds to the following methods:
-
#message_body => Types::MessageBody
-
See Also:
6198 6199 6200 6201 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6198 def update_endpoints_batch(params = {}, options = {}) req = build_request(:update_endpoints_batch, params) req.send_request(options) end |
#update_gcm_channel(params = {}) ⇒ Types::UpdateGcmChannelResponse
Use to update the GCM channel for an app.
Examples:
Request syntax with placeholder values
resp = client.update_gcm_channel({
application_id: "__string", # required
gcm_channel_request: { # required
api_key: "__string",
enabled: false,
},
})
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 #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.id #=> String
resp.gcm_channel_response.is_archived #=> Boolean
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:gcm_channel_request
(required, Types::GCMChannelRequest)
—
Google Cloud Messaging credentials
Returns:
-
(Types::UpdateGcmChannelResponse)
—
Returns a response object which responds to the following methods:
-
#gcm_channel_response => Types::GCMChannelResponse
-
See Also:
6242 6243 6244 6245 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6242 def update_gcm_channel(params = {}, options = {}) req = build_request(:update_gcm_channel, params) req.send_request(options) end |
#update_segment(params = {}) ⇒ Types::UpdateSegmentResponse
Used to update a segment.
Examples:
Request syntax with placeholder values
resp = client.update_segment({
application_id: "__string", # required
segment_id: "__string", # required
write_segment_request: { # required
dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
behavior: {
recency: {
duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
gps_point: {
coordinates: {
latitude: 1.0,
longitude: 1.0,
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
},
name: "__string",
segment_groups: {
groups: [
{
dimensions: [
{
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
behavior: {
recency: {
duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
gps_point: {
coordinates: {
latitude: 1.0,
longitude: 1.0,
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
},
],
source_segments: [
{
id: "__string",
version: 1,
},
],
source_type: "ALL", # accepts ALL, ANY, NONE
type: "ALL", # accepts ALL, ANY, NONE
},
],
include: "ALL", # accepts ALL, ANY, NONE
},
},
})
Response structure
resp.segment_response.application_id #=> 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.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
- :segment_id (required, String)
-
:write_segment_request
(required, Types::WriteSegmentRequest)
—
Segment definition.
Returns:
-
(Types::UpdateSegmentResponse)
—
Returns a response object which responds to the following methods:
-
#segment_response => Types::SegmentResponse
-
See Also:
6520 6521 6522 6523 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6520 def update_segment(params = {}, options = {}) req = build_request(:update_segment, params) req.send_request(options) end |
#update_sms_channel(params = {}) ⇒ Types::UpdateSmsChannelResponse
Update an SMS channel.
Examples:
Request syntax with placeholder values
resp = client.update_sms_channel({
application_id: "__string", # required
sms_channel_request: { # required
enabled: false,
sender_id: "__string",
short_code: "__string",
},
})
Response structure
resp.sms_channel_response.application_id #=> String
resp.sms_channel_response.creation_date #=> String
resp.sms_channel_response.enabled #=> Boolean
resp.sms_channel_response.has_credential #=> Boolean
resp.sms_channel_response.id #=> String
resp.sms_channel_response.is_archived #=> Boolean
resp.sms_channel_response.last_modified_by #=> String
resp.sms_channel_response.last_modified_date #=> String
resp.sms_channel_response.platform #=> String
resp.sms_channel_response.promotional_messages_per_second #=> Integer
resp.sms_channel_response.sender_id #=> String
resp.sms_channel_response.short_code #=> String
resp.sms_channel_response.transactional_messages_per_second #=> Integer
resp.sms_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:sms_channel_request
(required, Types::SMSChannelRequest)
—
SMS Channel Request
Returns:
-
(Types::UpdateSmsChannelResponse)
—
Returns a response object which responds to the following methods:
-
#sms_channel_response => Types::SMSChannelResponse
-
See Also:
6568 6569 6570 6571 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6568 def update_sms_channel(params = {}, options = {}) req = build_request(:update_sms_channel, params) req.send_request(options) end |
#update_voice_channel(params = {}) ⇒ Types::UpdateVoiceChannelResponse
Update an Voice channel
Examples:
Request syntax with placeholder values
resp = client.update_voice_channel({
application_id: "__string", # required
voice_channel_request: { # required
enabled: false,
},
})
Response structure
resp.voice_channel_response.application_id #=> String
resp.voice_channel_response.creation_date #=> String
resp.voice_channel_response.enabled #=> Boolean
resp.voice_channel_response.has_credential #=> Boolean
resp.voice_channel_response.id #=> String
resp.voice_channel_response.is_archived #=> Boolean
resp.voice_channel_response.last_modified_by #=> String
resp.voice_channel_response.last_modified_date #=> String
resp.voice_channel_response.platform #=> String
resp.voice_channel_response.version #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
- :application_id (required, String)
-
:voice_channel_request
(required, Types::VoiceChannelRequest)
—
Voice Channel Request
Returns:
-
(Types::UpdateVoiceChannelResponse)
—
Returns a response object which responds to the following methods:
-
#voice_channel_response => Types::VoiceChannelResponse
-
See Also:
6610 6611 6612 6613 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6610 def update_voice_channel(params = {}, options = {}) req = build_request(:update_voice_channel, params) req.send_request(options) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6634 6635 6636 |
# File 'lib/aws-sdk-pinpoint/client.rb', line 6634 def waiter_names [] end |