Class: Aws::Pinpoint::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-pinpoint/client.rb

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_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`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :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_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Pinpoint::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Pinpoint::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 444

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. 



13031
13032
13033
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 13031

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. 



13034
13035
13036
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 13034

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: {}) 


13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 13004

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Pinpoint')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-pinpoint'
  context[:gem_version] = '1.103.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Creates an application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_application_request (required, Types::CreateApplicationRequest) —

    Specifies the display name of an application and the tags to associate with the application.

Returns:

See Also:



484
485
486
487
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 484

def create_app(params = {}, options = {})
  req = build_request(:create_app, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.create_campaign({
  application_id: "__string", # required
  write_campaign_request: { # required
    additional_treatments: [
      {
        custom_delivery_configuration: {
          delivery_uri: "__string", # required
          endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
        },
        message_configuration: {
          adm_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          apns_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          baidu_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          custom_message: {
            data: "__string",
          },
          default_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          email_message: {
            body: "__string",
            from_address: "__string",
            headers: [
              {
                name: "__string",
                value: "__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
            origination_number: "__string",
            sender_id: "__string",
            entity_id: "__string",
            template_id: "__string",
          },
          in_app_message: {
            body: "__string",
            content: [
              {
                background_color: "__string",
                body_config: {
                  alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
                  body: "__string", # required
                  text_color: "__string", # required
                },
                header_config: {
                  alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
                  header: "__string", # required
                  text_color: "__string", # required
                },
                image_url: "__string",
                primary_btn: {
                  android: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  default_config: {
                    background_color: "__string",
                    border_radius: 1,
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                    text: "__string", # required
                    text_color: "__string",
                  },
                  ios: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  web: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                },
                secondary_btn: {
                  android: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  default_config: {
                    background_color: "__string",
                    border_radius: 1,
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                    text: "__string", # required
                    text_color: "__string",
                  },
                  ios: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  web: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                },
              },
            ],
            custom_config: {
              "__string" => "__string",
            },
            layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
          },
        },
        schedule: {
          end_time: "__string",
          event_filter: {
            dimensions: { # required
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
                  values: ["__string"], # required
                },
              },
              event_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
            },
            filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
          },
          frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
          is_local_time: false,
          quiet_time: {
            end: "__string",
            start: "__string",
          },
          start_time: "__string", # required
          timezone: "__string",
        },
        size_percent: 1, # required
        template_configuration: {
          email_template: {
            name: "__string",
            version: "__string",
          },
          push_template: {
            name: "__string",
            version: "__string",
          },
          sms_template: {
            name: "__string",
            version: "__string",
          },
          voice_template: {
            name: "__string",
            version: "__string",
          },
          in_app_template: {
            name: "__string",
            version: "__string",
          },
        },
        treatment_description: "__string",
        treatment_name: "__string",
      },
    ],
    custom_delivery_configuration: {
      delivery_uri: "__string", # required
      endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
    },
    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,
      session: 1,
    },
    message_configuration: {
      adm_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      apns_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      baidu_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      custom_message: {
        data: "__string",
      },
      default_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      email_message: {
        body: "__string",
        from_address: "__string",
        headers: [
          {
            name: "__string",
            value: "__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
        origination_number: "__string",
        sender_id: "__string",
        entity_id: "__string",
        template_id: "__string",
      },
      in_app_message: {
        body: "__string",
        content: [
          {
            background_color: "__string",
            body_config: {
              alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
              body: "__string", # required
              text_color: "__string", # required
            },
            header_config: {
              alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
              header: "__string", # required
              text_color: "__string", # required
            },
            image_url: "__string",
            primary_btn: {
              android: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              default_config: {
                background_color: "__string",
                border_radius: 1,
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
                text: "__string", # required
                text_color: "__string",
              },
              ios: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              web: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
            },
            secondary_btn: {
              android: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              default_config: {
                background_color: "__string",
                border_radius: 1,
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
                text: "__string", # required
                text_color: "__string",
              },
              ios: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              web: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
            },
          },
        ],
        custom_config: {
          "__string" => "__string",
        },
        layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
      },
    },
    name: "__string",
    schedule: {
      end_time: "__string",
      event_filter: {
        dimensions: { # required
          attributes: {
            "__string" => {
              attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
              values: ["__string"], # required
            },
          },
          event_type: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          metrics: {
            "__string" => {
              comparison_operator: "__string", # required
              value: 1.0, # required
            },
          },
        },
        filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
      },
      frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
      is_local_time: false,
      quiet_time: {
        end: "__string",
        start: "__string",
      },
      start_time: "__string", # required
      timezone: "__string",
    },
    segment_id: "__string",
    segment_version: 1,
    tags: {
      "__string" => "__string",
    },
    template_configuration: {
      email_template: {
        name: "__string",
        version: "__string",
      },
      push_template: {
        name: "__string",
        version: "__string",
      },
      sms_template: {
        name: "__string",
        version: "__string",
      },
      voice_template: {
        name: "__string",
        version: "__string",
      },
      in_app_template: {
        name: "__string",
        version: "__string",
      },
    },
    treatment_description: "__string",
    treatment_name: "__string",
    priority: 1,
  },
})

Response structure


resp.campaign_response.additional_treatments #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> 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.limits.session #=> 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.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.message_configuration.sms_message.entity_id #=> String
resp.campaign_response.message_configuration.sms_message.template_id #=> String
resp.campaign_response.message_configuration.in_app_message.body #=> String
resp.campaign_response.message_configuration.in_app_message.content #=> Array
resp.campaign_response.message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.template_configuration.in_app_template.name #=> String
resp.campaign_response.template_configuration.in_app_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
resp.campaign_response.priority #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :write_campaign_request (required, Types::WriteCampaignRequest) —

    Specifies the configuration and other settings for a campaign.

Returns:

See Also:



1304
1305
1306
1307
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 1304

def create_campaign(params = {}, options = {})
  req = build_request(:create_campaign, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_template_request (required, Types::EmailTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

  • :template_name (required, String)

Returns:

See Also:



1355
1356
1357
1358
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 1355

def create_email_template(params = {}, options = {})
  req = build_request(:create_email_template, params)
  req.send_request(options)
end

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

Creates an export job for an application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :export_job_request (required, Types::ExportJobRequest) —

    Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

See Also:



1408
1409
1410
1411
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 1408

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 an import job for an application.

Examples:

Request syntax with placeholder values


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

Response structure


resp.import_job_response.application_id #=> String
resp.import_job_response.completed_pieces #=> Integer
resp.import_job_response.completion_date #=> String
resp.import_job_response.creation_date #=> String
resp.import_job_response.definition.define_segment #=> 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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.import_job_response.total_failures #=> Integer
resp.import_job_response.total_pieces #=> Integer
resp.import_job_response.total_processed #=> Integer
resp.import_job_response.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :import_job_request (required, Types::ImportJobRequest) —

    Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

See Also:



1469
1470
1471
1472
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 1469

def create_import_job(params = {}, options = {})
  req = build_request(:create_import_job, params)
  req.send_request(options)
end

#create_in_app_template(params = {}) ⇒ Types::CreateInAppTemplateResponse

Creates a new message template for messages using the in-app message channel.

Examples:

Request syntax with placeholder values


resp = client.create_in_app_template({
  in_app_template_request: { # required
    content: [
      {
        background_color: "__string",
        body_config: {
          alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
          body: "__string", # required
          text_color: "__string", # required
        },
        header_config: {
          alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
          header: "__string", # required
          text_color: "__string", # required
        },
        image_url: "__string",
        primary_btn: {
          android: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          default_config: {
            background_color: "__string",
            border_radius: 1,
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
            text: "__string", # required
            text_color: "__string",
          },
          ios: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          web: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
        },
        secondary_btn: {
          android: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          default_config: {
            background_color: "__string",
            border_radius: 1,
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
            text: "__string", # required
            text_color: "__string",
          },
          ios: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          web: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
        },
      },
    ],
    custom_config: {
      "__string" => "__string",
    },
    layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
  },
  template_name: "__string", # required
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1572
1573
1574
1575
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 1572

def create_in_app_template(params = {}, options = {})
  req = build_request(:create_in_app_template, params)
  req.send_request(options)
end

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

Creates a journey for an application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :write_journey_request (required, Types::WriteJourneyRequest) —

    Specifies the configuration and other settings for a journey.

Returns:

See Also:



2246
2247
2248
2249
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2246

def create_journey(params = {}, options = {})
  req = build_request(:create_journey, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :push_notification_template_request (required, Types::PushNotificationTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

  • :template_name (required, String)

Returns:

See Also:



2337
2338
2339
2340
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2337

def create_push_template(params = {}, options = {})
  req = build_request(:create_push_template, params)
  req.send_request(options)
end

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

Creates an Amazon Pinpoint configuration for a recommender model.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_recommender_configuration (required, Types::CreateRecommenderConfiguration) —

    Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Returns:

See Also:



2390
2391
2392
2393
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2390

def create_recommender_configuration(params = {}, options = {})
  req = build_request(:create_recommender_configuration, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.segment_response.application_id #=> String
resp.segment_response.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :write_segment_request (required, Types::WriteSegmentRequest) —

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

Returns:

See Also:



2675
2676
2677
2678
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2675

def create_segment(params = {}, options = {})
  req = build_request(:create_segment, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sms_template_request (required, Types::SMSTemplateRequest) —

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

  • :template_name (required, String)

Returns:

See Also:



2718
2719
2720
2721
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2718

def create_sms_template(params = {}, options = {})
  req = build_request(:create_sms_template, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String)
  • :voice_template_request (required, Types::VoiceTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Returns:

See Also:



2762
2763
2764
2765
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2762

def create_voice_template(params = {}, options = {})
  req = build_request(:create_voice_template, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.adm_channel_response.application_id #=> String
resp.adm_channel_response.creation_date #=> String
resp.adm_channel_response.enabled #=> 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:

See Also:



2799
2800
2801
2802
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2799

def delete_adm_channel(params = {}, options = {})
  req = build_request(:delete_adm_channel, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.apns_channel_response.application_id #=> String
resp.apns_channel_response.creation_date #=> String
resp.apns_channel_response.default_authentication_method #=> String
resp.apns_channel_response.enabled #=> 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:

See Also:



2838
2839
2840
2841
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2838

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.apns_sandbox_channel_response.application_id #=> String
resp.apns_sandbox_channel_response.creation_date #=> String
resp.apns_sandbox_channel_response.default_authentication_method #=> String
resp.apns_sandbox_channel_response.enabled #=> 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:

See Also:



2877
2878
2879
2880
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2877

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.apns_voip_channel_response.application_id #=> String
resp.apns_voip_channel_response.creation_date #=> String
resp.apns_voip_channel_response.default_authentication_method #=> String
resp.apns_voip_channel_response.enabled #=> 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:

See Also:



2916
2917
2918
2919
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2916

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.apns_voip_sandbox_channel_response.application_id #=> String
resp.apns_voip_sandbox_channel_response.creation_date #=> String
resp.apns_voip_sandbox_channel_response.default_authentication_method #=> String
resp.apns_voip_sandbox_channel_response.enabled #=> 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:

See Also:



2955
2956
2957
2958
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2955

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



2987
2988
2989
2990
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 2987

def delete_app(params = {}, options = {})
  req = build_request(:delete_app, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.baidu_channel_response.application_id #=> String
resp.baidu_channel_response.creation_date #=> String
resp.baidu_channel_response.credential #=> String
resp.baidu_channel_response.enabled #=> 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:

See Also:



3025
3026
3027
3028
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3025

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 from an application.

Examples:

Request syntax with placeholder values


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

Response structure


resp.campaign_response.additional_treatments #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> 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.limits.session #=> 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.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.message_configuration.sms_message.entity_id #=> String
resp.campaign_response.message_configuration.sms_message.template_id #=> String
resp.campaign_response.message_configuration.in_app_message.body #=> String
resp.campaign_response.message_configuration.in_app_message.content #=> Array
resp.campaign_response.message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.template_configuration.in_app_template.name #=> String
resp.campaign_response.template_configuration.in_app_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
resp.campaign_response.priority #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



3371
3372
3373
3374
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3371

def delete_campaign(params = {}, options = {})
  req = build_request(:delete_campaign, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.email_channel_response.application_id #=> String
resp.email_channel_response.configuration_set #=> String
resp.email_channel_response.creation_date #=> String
resp.email_channel_response.enabled #=> 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.orchestration_sending_role_arn #=> String
resp.email_channel_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



3414
3415
3416
3417
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3414

def delete_email_channel(params = {}, options = {})
  req = build_request(:delete_email_channel, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



3446
3447
3448
3449
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3446

def delete_email_template(params = {}, options = {})
  req = build_request(:delete_email_template, params)
  req.send_request(options)
end

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

Deletes an endpoint from an application.

Examples:

Request syntax with placeholder values


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

Response structure


resp.endpoint_response.address #=> String
resp.endpoint_response.application_id #=> String
resp.endpoint_response.attributes #=> Hash
resp.endpoint_response.attributes["__string"] #=> Array
resp.endpoint_response.attributes["__string"][0] #=> String
resp.endpoint_response.channel_type #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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:

See Also:



3508
3509
3510
3511
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3508

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



3540
3541
3542
3543
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3540

def delete_event_stream(params = {}, options = {})
  req = build_request(:delete_event_stream, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.gcm_channel_response.application_id #=> String
resp.gcm_channel_response.creation_date #=> String
resp.gcm_channel_response.credential #=> String
resp.gcm_channel_response.default_authentication_method #=> String
resp.gcm_channel_response.enabled #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.has_fcm_service_credentials #=> 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:

See Also:



3580
3581
3582
3583
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3580

def delete_gcm_channel(params = {}, options = {})
  req = build_request(:delete_gcm_channel, params)
  req.send_request(options)
end

#delete_in_app_template(params = {}) ⇒ Types::DeleteInAppTemplateResponse

Deletes a message template for messages sent using the in-app message channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



3612
3613
3614
3615
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3612

def delete_in_app_template(params = {}, options = {})
  req = build_request(:delete_in_app_template, params)
  req.send_request(options)
end

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

Deletes a journey from an application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)

Returns:

See Also:



3868
3869
3870
3871
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3868

def delete_journey(params = {}, options = {})
  req = build_request(:delete_journey, params)
  req.send_request(options)
end

#delete_push_template(params = {}) ⇒ Types::DeletePushTemplateResponse

Deletes a message template for messages that were sent through a push notification channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



3900
3901
3902
3903
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3900

def delete_push_template(params = {}, options = {})
  req = build_request(:delete_push_template, params)
  req.send_request(options)
end

#delete_recommender_configuration(params = {}) ⇒ Types::DeleteRecommenderConfigurationResponse

Deletes an Amazon Pinpoint configuration for a recommender model.

Examples:

Request syntax with placeholder values


resp = client.delete_recommender_configuration({
  recommender_id: "__string", # required
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recommender_id (required, String)

Returns:

See Also:



3939
3940
3941
3942
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 3939

def delete_recommender_configuration(params = {}, options = {})
  req = build_request(:delete_recommender_configuration, params)
  req.send_request(options)
end

#delete_segment(params = {}) ⇒ Types::DeleteSegmentResponse

Deletes a segment from an application.

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.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :segment_id (required, String)

Returns:

See Also:



4067
4068
4069
4070
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4067

def delete_segment(params = {}, options = {})
  req = build_request(:delete_segment, params)
  req.send_request(options)
end

#delete_sms_channel(params = {}) ⇒ Types::DeleteSmsChannelResponse

Disables the SMS channel for an application and deletes any existing settings for the 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:

See Also:



4108
4109
4110
4111
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4108

def delete_sms_channel(params = {}, options = {})
  req = build_request(:delete_sms_channel, params)
  req.send_request(options)
end

#delete_sms_template(params = {}) ⇒ Types::DeleteSmsTemplateResponse

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



4140
4141
4142
4143
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4140

def delete_sms_template(params = {}, options = {})
  req = build_request(:delete_sms_template, params)
  req.send_request(options)
end

#delete_user_endpoints(params = {}) ⇒ Types::DeleteUserEndpointsResponse

Deletes all the endpoints that are associated with a specific 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 "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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:

See Also:



4203
4204
4205
4206
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4203

def delete_user_endpoints(params = {}, options = {})
  req = build_request(:delete_user_endpoints, params)
  req.send_request(options)
end

#delete_voice_channel(params = {}) ⇒ Types::DeleteVoiceChannelResponse

Disables the voice channel for an application and deletes any existing settings for the 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:

See Also:



4240
4241
4242
4243
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4240

def delete_voice_channel(params = {}, options = {})
  req = build_request(:delete_voice_channel, params)
  req.send_request(options)
end

#delete_voice_template(params = {}) ⇒ Types::DeleteVoiceTemplateResponse

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



4272
4273
4274
4275
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4272

def delete_voice_template(params = {}, options = {})
  req = build_request(:delete_voice_template, params)
  req.send_request(options)
end

#get_adm_channel(params = {}) ⇒ Types::GetAdmChannelResponse

Retrieves information about the status and settings of the ADM channel for an application.

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:

See Also:



4309
4310
4311
4312
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4309

def get_adm_channel(params = {}, options = {})
  req = build_request(:get_adm_channel, params)
  req.send_request(options)
end

#get_apns_channel(params = {}) ⇒ Types::GetApnsChannelResponse

Retrieves information about the status and settings of the APNs channel for an application.

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:

See Also:



4348
4349
4350
4351
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4348

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

Retrieves information about the status and settings of the APNs sandbox channel for an application.

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:

See Also:



4387
4388
4389
4390
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4387

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

Retrieves information about the status and settings of the APNs VoIP channel for an application.

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:

See Also:



4426
4427
4428
4429
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4426

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

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

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:

See Also:



4465
4466
4467
4468
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4465

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

Retrieves information about an application.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



4497
4498
4499
4500
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4497

def get_app(params = {}, options = {})
  req = build_request(:get_app, params)
  req.send_request(options)
end

#get_application_date_range_kpi(params = {}) ⇒ Types::GetApplicationDateRangeKpiResponse

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

Examples:

Request syntax with placeholder values


resp = client.get_application_date_range_kpi({
  application_id: "__string", # required
  end_time: Time.now,
  kpi_name: "__string", # required
  next_token: "__string",
  page_size: "__string",
  start_time: Time.now,
})

Response structure


resp.application_date_range_kpi_response.application_id #=> String
resp.application_date_range_kpi_response.end_time #=> Time
resp.application_date_range_kpi_response.kpi_name #=> String
resp.application_date_range_kpi_response.kpi_result.rows #=> Array
resp.application_date_range_kpi_response.kpi_result.rows[0].grouped_bys #=> Array
resp.application_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].key #=> String
resp.application_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].type #=> String
resp.application_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].value #=> String
resp.application_date_range_kpi_response.kpi_result.rows[0].values #=> Array
resp.application_date_range_kpi_response.kpi_result.rows[0].values[0].key #=> String
resp.application_date_range_kpi_response.kpi_result.rows[0].values[0].type #=> String
resp.application_date_range_kpi_response.kpi_result.rows[0].values[0].value #=> String
resp.application_date_range_kpi_response.next_token #=> String
resp.application_date_range_kpi_response.start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :end_time (Time, DateTime, Date, Integer, String)
  • :kpi_name (required, String)
  • :next_token (String)
  • :page_size (String)
  • :start_time (Time, DateTime, Date, Integer, String)

Returns:

See Also:



4553
4554
4555
4556
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4553

def get_application_date_range_kpi(params = {}, options = {})
  req = build_request(:get_application_date_range_kpi, params)
  req.send_request(options)
end

#get_application_settings(params = {}) ⇒ Types::GetApplicationSettingsResponse

Retrieves information about the settings for an application.

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.limits.session #=> Integer
resp.application_settings_resource.quiet_time.end #=> String
resp.application_settings_resource.quiet_time.start #=> String
resp.application_settings_resource.journey_limits.daily_cap #=> Integer
resp.application_settings_resource.journey_limits.timeframe_cap.cap #=> Integer
resp.application_settings_resource.journey_limits.timeframe_cap.days #=> Integer
resp.application_settings_resource.journey_limits.total_cap #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



4595
4596
4597
4598
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4595

def get_application_settings(params = {}, options = {})
  req = build_request(:get_application_settings, params)
  req.send_request(options)
end

#get_apps(params = {}) ⇒ Types::GetAppsResponse

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

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].arn #=> String
resp.applications_response.item[0].id #=> String
resp.applications_response.item[0].name #=> String
resp.applications_response.item[0].tags #=> Hash
resp.applications_response.item[0].tags["__string"] #=> String
resp.applications_response.item[0].creation_date #=> String
resp.applications_response.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :page_size (String)
  • :token (String)

Returns:

See Also:



4633
4634
4635
4636
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4633

def get_apps(params = {}, options = {})
  req = build_request(:get_apps, params)
  req.send_request(options)
end

#get_baidu_channel(params = {}) ⇒ Types::GetBaiduChannelResponse

Retrieves information about the status and settings of the Baidu channel for an application.

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:

See Also:



4671
4672
4673
4674
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 4671

def get_baidu_channel(params = {}, options = {})
  req = build_request(:get_baidu_channel, params)
  req.send_request(options)
end

#get_campaign(params = {}) ⇒ Types::GetCampaignResponse

Retrieves information about the status, configuration, and other settings for 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].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> 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.limits.session #=> 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.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.message_configuration.sms_message.entity_id #=> String
resp.campaign_response.message_configuration.sms_message.template_id #=> String
resp.campaign_response.message_configuration.in_app_message.body #=> String
resp.campaign_response.message_configuration.in_app_message.content #=> Array
resp.campaign_response.message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.template_configuration.in_app_template.name #=> String
resp.campaign_response.template_configuration.in_app_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
resp.campaign_response.priority #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



5018
5019
5020
5021
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 5018

def get_campaign(params = {}, options = {})
  req = build_request(:get_campaign, params)
  req.send_request(options)
end

#get_campaign_activities(params = {}) ⇒ Types::GetCampaignActivitiesResponse

Retrieves information about all the activities for 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.item[0].execution_metrics #=> Hash
resp.activities_response.item[0].execution_metrics["__string"] #=> 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:

See Also:



5070
5071
5072
5073
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 5070

def get_campaign_activities(params = {}, options = {})
  req = build_request(:get_campaign_activities, params)
  req.send_request(options)
end

#get_campaign_date_range_kpi(params = {}) ⇒ Types::GetCampaignDateRangeKpiResponse

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

Examples:

Request syntax with placeholder values


resp = client.get_campaign_date_range_kpi({
  application_id: "__string", # required
  campaign_id: "__string", # required
  end_time: Time.now,
  kpi_name: "__string", # required
  next_token: "__string",
  page_size: "__string",
  start_time: Time.now,
})

Response structure


resp.campaign_date_range_kpi_response.application_id #=> String
resp.campaign_date_range_kpi_response.campaign_id #=> String
resp.campaign_date_range_kpi_response.end_time #=> Time
resp.campaign_date_range_kpi_response.kpi_name #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows #=> Array
resp.campaign_date_range_kpi_response.kpi_result.rows[0].grouped_bys #=> Array
resp.campaign_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].key #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].type #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].value #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows[0].values #=> Array
resp.campaign_date_range_kpi_response.kpi_result.rows[0].values[0].key #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows[0].values[0].type #=> String
resp.campaign_date_range_kpi_response.kpi_result.rows[0].values[0].value #=> String
resp.campaign_date_range_kpi_response.next_token #=> String
resp.campaign_date_range_kpi_response.start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :campaign_id (required, String)
  • :end_time (Time, DateTime, Date, Integer, String)
  • :kpi_name (required, String)
  • :next_token (String)
  • :page_size (String)
  • :start_time (Time, DateTime, Date, Integer, String)

Returns:

See Also:



5130
5131
5132
5133
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 5130

def get_campaign_date_range_kpi(params = {}, options = {})
  req = build_request(:get_campaign_date_range_kpi, params)
  req.send_request(options)
end

#get_campaign_version(params = {}) ⇒ Types::GetCampaignVersionResponse

Retrieves information about the status, configuration, and other settings for 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].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> 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.limits.session #=> 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.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.message_configuration.sms_message.entity_id #=> String
resp.campaign_response.message_configuration.sms_message.template_id #=> String
resp.campaign_response.message_configuration.in_app_message.body #=> String
resp.campaign_response.message_configuration.in_app_message.content #=> Array
resp.campaign_response.message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.template_configuration.in_app_template.name #=> String
resp.campaign_response.template_configuration.in_app_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
resp.campaign_response.priority #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



5480
5481
5482
5483
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 5480

def get_campaign_version(params = {}, options = {})
  req = build_request(:get_campaign_version, params)
  req.send_request(options)
end

#get_campaign_versions(params = {}) ⇒ Types::GetCampaignVersionsResponse

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

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].custom_delivery_configuration.delivery_uri #=> String
resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> 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.headers #=> Array
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.in_app_template.version #=> String
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].arn #=> String
resp.campaigns_response.item[0].creation_date #=> String
resp.campaigns_response.item[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
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].limits.session #=> 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.custom_message.data #=> 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.headers #=> Array
resp.campaigns_response.item[0].message_configuration.email_message.headers[0].name #=> String
resp.campaigns_response.item[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.entity_id #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.template_id #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.body #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content #=> Array
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaigns_response.item[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaigns_response.item[0].tags #=> Hash
resp.campaigns_response.item[0].tags["__string"] #=> String
resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
resp.campaigns_response.item[0].template_configuration.email_template.version #=> String
resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
resp.campaigns_response.item[0].template_configuration.push_template.version #=> String
resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
resp.campaigns_response.item[0].template_configuration.sms_template.version #=> String
resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
resp.campaigns_response.item[0].template_configuration.voice_template.version #=> String
resp.campaigns_response.item[0].template_configuration.in_app_template.name #=> String
resp.campaigns_response.item[0].template_configuration.in_app_template.version #=> String
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.item[0].priority #=> 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:

See Also:



5835
5836
5837
5838
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 5835

def get_campaign_versions(params = {}, options = {})
  req = build_request(:get_campaign_versions, params)
  req.send_request(options)
end

#get_campaigns(params = {}) ⇒ Types::GetCampaignsResponse

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

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].custom_delivery_configuration.delivery_uri #=> String
resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> 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.headers #=> Array
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaigns_response.item[0].additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaigns_response.item[0].additional_treatments[0].template_configuration.in_app_template.version #=> String
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].arn #=> String
resp.campaigns_response.item[0].creation_date #=> String
resp.campaigns_response.item[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
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].limits.session #=> 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.custom_message.data #=> 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.headers #=> Array
resp.campaigns_response.item[0].message_configuration.email_message.headers[0].name #=> String
resp.campaigns_response.item[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.sender_id #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.entity_id #=> String
resp.campaigns_response.item[0].message_configuration.sms_message.template_id #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.body #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content #=> Array
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaigns_response.item[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaigns_response.item[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaigns_response.item[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaigns_response.item[0].tags #=> Hash
resp.campaigns_response.item[0].tags["__string"] #=> String
resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
resp.campaigns_response.item[0].template_configuration.email_template.version #=> String
resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
resp.campaigns_response.item[0].template_configuration.push_template.version #=> String
resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
resp.campaigns_response.item[0].template_configuration.sms_template.version #=> String
resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
resp.campaigns_response.item[0].template_configuration.voice_template.version #=> String
resp.campaigns_response.item[0].template_configuration.in_app_template.name #=> String
resp.campaigns_response.item[0].template_configuration.in_app_template.version #=> String
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.item[0].priority #=> 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:

See Also:



6188
6189
6190
6191
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6188

def get_campaigns(params = {}, options = {})
  req = build_request(:get_campaigns, params)
  req.send_request(options)
end

#get_channels(params = {}) ⇒ Types::GetChannelsResponse

Retrieves information about the history and status of each channel for an application.

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:

See Also:



6225
6226
6227
6228
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6225

def get_channels(params = {}, options = {})
  req = build_request(:get_channels, params)
  req.send_request(options)
end

#get_email_channel(params = {}) ⇒ Types::GetEmailChannelResponse

Retrieves information about the status and settings of the email channel for an application.

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.orchestration_sending_role_arn #=> String
resp.email_channel_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



6268
6269
6270
6271
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6268

def get_email_channel(params = {}, options = {})
  req = build_request(:get_email_channel, params)
  req.send_request(options)
end

#get_email_template(params = {}) ⇒ Types::GetEmailTemplateResponse

Retrieves the content and settings of a message template for messages that are sent through the email channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.email_template_response.arn #=> String
resp.email_template_response.creation_date #=> String
resp.email_template_response.default_substitutions #=> String
resp.email_template_response.html_part #=> String
resp.email_template_response.last_modified_date #=> String
resp.email_template_response.recommender_id #=> String
resp.email_template_response.subject #=> String
resp.email_template_response.headers #=> Array
resp.email_template_response.headers[0].name #=> String
resp.email_template_response.headers[0].value #=> String
resp.email_template_response.tags #=> Hash
resp.email_template_response.tags["__string"] #=> String
resp.email_template_response.template_description #=> String
resp.email_template_response.template_name #=> String
resp.email_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.email_template_response.text_part #=> String
resp.email_template_response.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



6315
6316
6317
6318
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6315

def get_email_template(params = {}, options = {})
  req = build_request(:get_email_template, params)
  req.send_request(options)
end

#get_endpoint(params = {}) ⇒ Types::GetEndpointResponse

Retrieves information about the settings and attributes of a specific endpoint for an application.

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 "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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:

See Also:



6378
6379
6380
6381
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6378

def get_endpoint(params = {}, options = {})
  req = build_request(:get_endpoint, params)
  req.send_request(options)
end

#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse

Retrieves information about the event stream settings for an application.

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:

See Also:



6411
6412
6413
6414
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6411

def get_event_stream(params = {}, options = {})
  req = build_request(:get_event_stream, params)
  req.send_request(options)
end

#get_export_job(params = {}) ⇒ Types::GetExportJobResponse

Retrieves information about the status and settings of a specific export job for an application.

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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.export_job_response.total_failures #=> Integer
resp.export_job_response.total_pieces #=> Integer
resp.export_job_response.total_processed #=> Integer
resp.export_job_response.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :job_id (required, String)

Returns:

See Also:



6458
6459
6460
6461
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6458

def get_export_job(params = {}, options = {})
  req = build_request(:get_export_job, params)
  req.send_request(options)
end

#get_export_jobs(params = {}) ⇒ Types::GetExportJobsResponse

Retrieves information about the status and settings of all the export jobs for an application.

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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "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:

See Also:



6510
6511
6512
6513
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6510

def get_export_jobs(params = {}, options = {})
  req = build_request(:get_export_jobs, params)
  req.send_request(options)
end

#get_gcm_channel(params = {}) ⇒ Types::GetGcmChannelResponse

Retrieves information about the status and settings of the GCM channel for an application.

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.default_authentication_method #=> String
resp.gcm_channel_response.enabled #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.has_fcm_service_credentials #=> 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:

See Also:



6550
6551
6552
6553
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6550

def get_gcm_channel(params = {}, options = {})
  req = build_request(:get_gcm_channel, params)
  req.send_request(options)
end

#get_import_job(params = {}) ⇒ Types::GetImportJobResponse

Retrieves information about the status and settings of a specific import job for an application.

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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
resp.import_job_response.total_failures #=> Integer
resp.import_job_response.total_pieces #=> Integer
resp.import_job_response.total_processed #=> Integer
resp.import_job_response.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :job_id (required, String)

Returns:

See Also:



6601
6602
6603
6604
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6601

def get_import_job(params = {}, options = {})
  req = build_request(:get_import_job, params)
  req.send_request(options)
end

#get_import_jobs(params = {}) ⇒ Types::GetImportJobsResponse

Retrieves information about the status and settings of all the import jobs for an application.

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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "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:

See Also:



6657
6658
6659
6660
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6657

def get_import_jobs(params = {}, options = {})
  req = build_request(:get_import_jobs, params)
  req.send_request(options)
end

#get_in_app_messages(params = {}) ⇒ Types::GetInAppMessagesResponse

Retrieves the in-app messages targeted for the provided endpoint ID.

Examples:

Request syntax with placeholder values


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

Response structure


resp.in_app_messages_response.in_app_message_campaigns #=> Array
resp.in_app_messages_response.in_app_message_campaigns[0].campaign_id #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].daily_cap #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content #=> Array
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].background_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].body_config.body #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].body_config.text_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].header_config.header #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].header_config.text_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].image_url #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.android.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.text #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.ios.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].primary_btn.web.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.android.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.ios.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.content[0].secondary_btn.web.link #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.custom_config #=> Hash
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.custom_config["__string"] #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
resp.in_app_messages_response.in_app_message_campaigns[0].priority #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.end_date #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.attributes #=> Hash
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.attributes["__string"].values #=> Array
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.event_type.values #=> Array
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.event_type.values[0] #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.metrics #=> Hash
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.dimensions.metrics["__string"].value #=> Float
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.quiet_time.end #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].schedule.quiet_time.start #=> String
resp.in_app_messages_response.in_app_message_campaigns[0].session_cap #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].total_cap #=> Integer
resp.in_app_messages_response.in_app_message_campaigns[0].treatment_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



6743
6744
6745
6746
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6743

def get_in_app_messages(params = {}, options = {})
  req = build_request(:get_in_app_messages, params)
  req.send_request(options)
end

#get_in_app_template(params = {}) ⇒ Types::GetInAppTemplateResponse

Retrieves the content and settings of a message template for messages sent through the in-app channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.in_app_template_response.arn #=> String
resp.in_app_template_response.content #=> Array
resp.in_app_template_response.content[0].background_color #=> String
resp.in_app_template_response.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.in_app_template_response.content[0].body_config.body #=> String
resp.in_app_template_response.content[0].body_config.text_color #=> String
resp.in_app_template_response.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.in_app_template_response.content[0].header_config.header #=> String
resp.in_app_template_response.content[0].header_config.text_color #=> String
resp.in_app_template_response.content[0].image_url #=> String
resp.in_app_template_response.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].primary_btn.android.link #=> String
resp.in_app_template_response.content[0].primary_btn.default_config.background_color #=> String
resp.in_app_template_response.content[0].primary_btn.default_config.border_radius #=> Integer
resp.in_app_template_response.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].primary_btn.default_config.link #=> String
resp.in_app_template_response.content[0].primary_btn.default_config.text #=> String
resp.in_app_template_response.content[0].primary_btn.default_config.text_color #=> String
resp.in_app_template_response.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].primary_btn.ios.link #=> String
resp.in_app_template_response.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].primary_btn.web.link #=> String
resp.in_app_template_response.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].secondary_btn.android.link #=> String
resp.in_app_template_response.content[0].secondary_btn.default_config.background_color #=> String
resp.in_app_template_response.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.in_app_template_response.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].secondary_btn.default_config.link #=> String
resp.in_app_template_response.content[0].secondary_btn.default_config.text #=> String
resp.in_app_template_response.content[0].secondary_btn.default_config.text_color #=> String
resp.in_app_template_response.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].secondary_btn.ios.link #=> String
resp.in_app_template_response.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.in_app_template_response.content[0].secondary_btn.web.link #=> String
resp.in_app_template_response.creation_date #=> String
resp.in_app_template_response.custom_config #=> Hash
resp.in_app_template_response.custom_config["__string"] #=> String
resp.in_app_template_response.last_modified_date #=> String
resp.in_app_template_response.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
resp.in_app_template_response.tags #=> Hash
resp.in_app_template_response.tags["__string"] #=> String
resp.in_app_template_response.template_description #=> String
resp.in_app_template_response.template_name #=> String
resp.in_app_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.in_app_template_response.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



6818
6819
6820
6821
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 6818

def get_in_app_template(params = {}, options = {})
  req = build_request(:get_in_app_template, params)
  req.send_request(options)
end

#get_journey(params = {}) ⇒ Types::GetJourneyResponse

Retrieves information about the status, configuration, and other settings for a journey.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)

Returns:

See Also:



7075
7076
7077
7078
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7075

def get_journey(params = {}, options = {})
  req = build_request(:get_journey, params)
  req.send_request(options)
end

#get_journey_date_range_kpi(params = {}) ⇒ Types::GetJourneyDateRangeKpiResponse

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

Examples:

Request syntax with placeholder values


resp = client.get_journey_date_range_kpi({
  application_id: "__string", # required
  end_time: Time.now,
  journey_id: "__string", # required
  kpi_name: "__string", # required
  next_token: "__string",
  page_size: "__string",
  start_time: Time.now,
})

Response structure


resp.journey_date_range_kpi_response.application_id #=> String
resp.journey_date_range_kpi_response.end_time #=> Time
resp.journey_date_range_kpi_response.journey_id #=> String
resp.journey_date_range_kpi_response.kpi_name #=> String
resp.journey_date_range_kpi_response.kpi_result.rows #=> Array
resp.journey_date_range_kpi_response.kpi_result.rows[0].grouped_bys #=> Array
resp.journey_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].key #=> String
resp.journey_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].type #=> String
resp.journey_date_range_kpi_response.kpi_result.rows[0].grouped_bys[0].value #=> String
resp.journey_date_range_kpi_response.kpi_result.rows[0].values #=> Array
resp.journey_date_range_kpi_response.kpi_result.rows[0].values[0].key #=> String
resp.journey_date_range_kpi_response.kpi_result.rows[0].values[0].type #=> String
resp.journey_date_range_kpi_response.kpi_result.rows[0].values[0].value #=> String
resp.journey_date_range_kpi_response.next_token #=> String
resp.journey_date_range_kpi_response.start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :end_time (Time, DateTime, Date, Integer, String)
  • :journey_id (required, String)
  • :kpi_name (required, String)
  • :next_token (String)
  • :page_size (String)
  • :start_time (Time, DateTime, Date, Integer, String)

Returns:

See Also:



7135
7136
7137
7138
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7135

def get_journey_date_range_kpi(params = {}, options = {})
  req = build_request(:get_journey_date_range_kpi, params)
  req.send_request(options)
end

#get_journey_execution_activity_metrics(params = {}) ⇒ Types::GetJourneyExecutionActivityMetricsResponse

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

Examples:

Request syntax with placeholder values


resp = client.get_journey_execution_activity_metrics({
  application_id: "__string", # required
  journey_activity_id: "__string", # required
  journey_id: "__string", # required
  next_token: "__string",
  page_size: "__string",
})

Response structure


resp.journey_execution_activity_metrics_response.activity_type #=> String
resp.journey_execution_activity_metrics_response.application_id #=> String
resp.journey_execution_activity_metrics_response.journey_activity_id #=> String
resp.journey_execution_activity_metrics_response.journey_id #=> String
resp.journey_execution_activity_metrics_response.last_evaluated_time #=> String
resp.journey_execution_activity_metrics_response.metrics #=> Hash
resp.journey_execution_activity_metrics_response.metrics["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_activity_id (required, String)
  • :journey_id (required, String)
  • :next_token (String)
  • :page_size (String)

Returns:

See Also:



7181
7182
7183
7184
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7181

def get_journey_execution_activity_metrics(params = {}, options = {})
  req = build_request(:get_journey_execution_activity_metrics, params)
  req.send_request(options)
end

#get_journey_execution_metrics(params = {}) ⇒ Types::GetJourneyExecutionMetricsResponse

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

Examples:

Request syntax with placeholder values


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

Response structure


resp.journey_execution_metrics_response.application_id #=> String
resp.journey_execution_metrics_response.journey_id #=> String
resp.journey_execution_metrics_response.last_evaluated_time #=> String
resp.journey_execution_metrics_response.metrics #=> Hash
resp.journey_execution_metrics_response.metrics["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)
  • :next_token (String)
  • :page_size (String)

Returns:

See Also:



7222
7223
7224
7225
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7222

def get_journey_execution_metrics(params = {}, options = {})
  req = build_request(:get_journey_execution_metrics, params)
  req.send_request(options)
end

#get_journey_run_execution_activity_metrics(params = {}) ⇒ Types::GetJourneyRunExecutionActivityMetricsResponse

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

Examples:

Example: To get the activity execution metrics for a journey run


# The following example gets activity execution metrics for a single run of a journey.

resp = client.get_journey_run_execution_activity_metrics({
  application_id: "11111111112222222222333333333344", 
  journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd", 
  run_id: "99999999998888888888777777777766", 
  journey_activity_id: "AAAAAAAAAA", 
})

resp.to_h outputs the following:
{
  journey_run_execution_activity_metrics_response: {
    application_id: "11111111112222222222333333333344", 
    journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd", 
    run_id: "99999999998888888888777777777766", 
    journey_activity_id: "AAAAAAAAAA", 
    activity_type: "EMAIL", 
    last_evaluated_time: "2000-01-01T00:00:05.000Z", 
    metrics: {
      "SUCCESS" => "1", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_journey_run_execution_activity_metrics({
  application_id: "__string", # required
  journey_activity_id: "__string", # required
  journey_id: "__string", # required
  next_token: "__string",
  page_size: "__string",
  run_id: "__string", # required
})

Response structure


resp.journey_run_execution_activity_metrics_response.activity_type #=> String
resp.journey_run_execution_activity_metrics_response.application_id #=> String
resp.journey_run_execution_activity_metrics_response.journey_activity_id #=> String
resp.journey_run_execution_activity_metrics_response.journey_id #=> String
resp.journey_run_execution_activity_metrics_response.last_evaluated_time #=> String
resp.journey_run_execution_activity_metrics_response.metrics #=> Hash
resp.journey_run_execution_activity_metrics_response.metrics["__string"] #=> String
resp.journey_run_execution_activity_metrics_response.run_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_activity_id (required, String)
  • :journey_id (required, String)
  • :next_token (String)
  • :page_size (String)
  • :run_id (required, String)

Returns:

See Also:



7299
7300
7301
7302
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7299

def get_journey_run_execution_activity_metrics(params = {}, options = {})
  req = build_request(:get_journey_run_execution_activity_metrics, params)
  req.send_request(options)
end

#get_journey_run_execution_metrics(params = {}) ⇒ Types::GetJourneyRunExecutionMetricsResponse

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

Examples:

Example: To get the execution metrics for a journey run


# The following example gets execution metrics for a single run of a journey.

resp = client.get_journey_run_execution_metrics({
  application_id: "11111111112222222222333333333344", 
  journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd", 
  run_id: "99999999998888888888777777777766", 
})

resp.to_h outputs the following:
{
  journey_run_execution_metrics_response: {
    application_id: "11111111112222222222333333333344", 
    journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd", 
    run_id: "99999999998888888888777777777766", 
    last_evaluated_time: "2000-01-01T00:00:05.000Z", 
    metrics: {
      "ENDPOINT_PRODUCED" => "1", 
      "ENDPOINT_ENTERED" => "1", 
      "ENDPOINT_LEFT" => "1", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.get_journey_run_execution_metrics({
  application_id: "__string", # required
  journey_id: "__string", # required
  next_token: "__string",
  page_size: "__string",
  run_id: "__string", # required
})

Response structure


resp.journey_run_execution_metrics_response.application_id #=> String
resp.journey_run_execution_metrics_response.journey_id #=> String
resp.journey_run_execution_metrics_response.last_evaluated_time #=> String
resp.journey_run_execution_metrics_response.metrics #=> Hash
resp.journey_run_execution_metrics_response.metrics["__string"] #=> String
resp.journey_run_execution_metrics_response.run_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)
  • :next_token (String)
  • :page_size (String)
  • :run_id (required, String)

Returns:

See Also:



7370
7371
7372
7373
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7370

def get_journey_run_execution_metrics(params = {}, options = {})
  req = build_request(:get_journey_run_execution_metrics, params)
  req.send_request(options)
end

#get_journey_runs(params = {}) ⇒ Types::GetJourneyRunsResponse

Provides information about the runs of a journey.

Examples:

Example: To get the runs of a journey


# The following example gets the runs of a journey.

resp = client.get_journey_runs({
  application_id: "11111111112222222222333333333344", 
  journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd", 
})

resp.to_h outputs the following:
{
  journey_runs_response: {
    item: [
      {
        run_id: "99999999998888888888777777777766", 
        creation_time: "2000-01-01T00:00:00.000Z", 
        last_update_time: "2000-01-01T00:00:05.000Z", 
        status: "COMPLETED", 
      }, 
      {
        run_id: "ffffffffffeeeeeeeeeeddddddddddcc", 
        creation_time: "2000-01-01T00:00:10.000Z", 
        last_update_time: "2000-01-01T00:00:10.000Z", 
        status: "SCHEDULED", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.journey_runs_response.item #=> Array
resp.journey_runs_response.item[0].creation_time #=> String
resp.journey_runs_response.item[0].last_update_time #=> String
resp.journey_runs_response.item[0].run_id #=> String
resp.journey_runs_response.item[0].status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETED", "CANCELLED"
resp.journey_runs_response.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)
  • :page_size (String)
  • :token (String)

Returns:

See Also:



7441
7442
7443
7444
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7441

def get_journey_runs(params = {}, options = {})
  req = build_request(:get_journey_runs, params)
  req.send_request(options)
end

#get_push_template(params = {}) ⇒ Types::GetPushTemplateResponse

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.push_notification_template_response.adm.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.push_notification_template_response.adm.body #=> String
resp.push_notification_template_response.adm.image_icon_url #=> String
resp.push_notification_template_response.adm.image_url #=> String
resp.push_notification_template_response.adm.raw_content #=> String
resp.push_notification_template_response.adm.small_image_icon_url #=> String
resp.push_notification_template_response.adm.sound #=> String
resp.push_notification_template_response.adm.title #=> String
resp.push_notification_template_response.adm.url #=> String
resp.push_notification_template_response.apns.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.push_notification_template_response.apns.body #=> String
resp.push_notification_template_response.apns.media_url #=> String
resp.push_notification_template_response.apns.raw_content #=> String
resp.push_notification_template_response.apns.sound #=> String
resp.push_notification_template_response.apns.title #=> String
resp.push_notification_template_response.apns.url #=> String
resp.push_notification_template_response.arn #=> String
resp.push_notification_template_response.baidu.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.push_notification_template_response.baidu.body #=> String
resp.push_notification_template_response.baidu.image_icon_url #=> String
resp.push_notification_template_response.baidu.image_url #=> String
resp.push_notification_template_response.baidu.raw_content #=> String
resp.push_notification_template_response.baidu.small_image_icon_url #=> String
resp.push_notification_template_response.baidu.sound #=> String
resp.push_notification_template_response.baidu.title #=> String
resp.push_notification_template_response.baidu.url #=> String
resp.push_notification_template_response.creation_date #=> String
resp.push_notification_template_response.default.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.push_notification_template_response.default.body #=> String
resp.push_notification_template_response.default.sound #=> String
resp.push_notification_template_response.default.title #=> String
resp.push_notification_template_response.default.url #=> String
resp.push_notification_template_response.default_substitutions #=> String
resp.push_notification_template_response.gcm.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.push_notification_template_response.gcm.body #=> String
resp.push_notification_template_response.gcm.image_icon_url #=> String
resp.push_notification_template_response.gcm.image_url #=> String
resp.push_notification_template_response.gcm.raw_content #=> String
resp.push_notification_template_response.gcm.small_image_icon_url #=> String
resp.push_notification_template_response.gcm.sound #=> String
resp.push_notification_template_response.gcm.title #=> String
resp.push_notification_template_response.gcm.url #=> String
resp.push_notification_template_response.last_modified_date #=> String
resp.push_notification_template_response.recommender_id #=> String
resp.push_notification_template_response.tags #=> Hash
resp.push_notification_template_response.tags["__string"] #=> String
resp.push_notification_template_response.template_description #=> String
resp.push_notification_template_response.template_name #=> String
resp.push_notification_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.push_notification_template_response.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



7521
7522
7523
7524
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7521

def get_push_template(params = {}, options = {})
  req = build_request(:get_push_template, params)
  req.send_request(options)
end

#get_recommender_configuration(params = {}) ⇒ Types::GetRecommenderConfigurationResponse

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

Examples:

Request syntax with placeholder values


resp = client.get_recommender_configuration({
  recommender_id: "__string", # required
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recommender_id (required, String)

Returns:

See Also:



7561
7562
7563
7564
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7561

def get_recommender_configuration(params = {}, options = {})
  req = build_request(:get_recommender_configuration, params)
  req.send_request(options)
end

#get_recommender_configurations(params = {}) ⇒ Types::GetRecommenderConfigurationsResponse

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

Examples:

Request syntax with placeholder values


resp = client.get_recommender_configurations({
  page_size: "__string",
  token: "__string",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :page_size (String)
  • :token (String)

Returns:

See Also:



7606
7607
7608
7609
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7606

def get_recommender_configurations(params = {}, options = {})
  req = build_request(:get_recommender_configurations, params)
  req.send_request(options)
end

#get_segment(params = {}) ⇒ Types::GetSegmentResponse

Retrieves information about the configuration, dimension, and other settings for a specific segment that’s associated with an application.

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.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :segment_id (required, String)

Returns:

See Also:



7736
7737
7738
7739
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7736

def get_segment(params = {}, options = {})
  req = build_request(:get_segment, params)
  req.send_request(options)
end

#get_segment_export_jobs(params = {}) ⇒ Types::GetSegmentExportJobsResponse

Retrieves information about the status and settings of the export jobs for a 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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "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:

See Also:



7791
7792
7793
7794
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7791

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

Retrieves information about the status and settings of the import jobs for a 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", "PREPARING_FOR_INITIALIZATION", "INITIALIZING", "PROCESSING", "PENDING_JOB", "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:

See Also:



7850
7851
7852
7853
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7850

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

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that’s associated with an application.

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.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :segment_id (required, String)
  • :version (required, String)

Returns:

See Also:



7983
7984
7985
7986
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 7983

def get_segment_version(params = {}, options = {})
  req = build_request(:get_segment_version, params)
  req.send_request(options)
end

#get_segment_versions(params = {}) ⇒ Types::GetSegmentVersionsResponse

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that’s associated with an application.

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].arn #=> 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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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].tags #=> Hash
resp.segments_response.item[0].tags["__string"] #=> String
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:

See Also:



8121
8122
8123
8124
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8121

def get_segment_versions(params = {}, options = {})
  req = build_request(:get_segment_versions, params)
  req.send_request(options)
end

#get_segments(params = {}) ⇒ Types::GetSegmentsResponse

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

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].arn #=> 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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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].tags #=> Hash
resp.segments_response.item[0].tags["__string"] #=> String
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:

See Also:



8255
8256
8257
8258
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8255

def get_segments(params = {}, options = {})
  req = build_request(:get_segments, params)
  req.send_request(options)
end

#get_sms_channel(params = {}) ⇒ Types::GetSmsChannelResponse

Retrieves information about the status and settings of the SMS channel for an application.

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:

See Also:



8296
8297
8298
8299
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8296

def get_sms_channel(params = {}, options = {})
  req = build_request(:get_sms_channel, params)
  req.send_request(options)
end

#get_sms_template(params = {}) ⇒ Types::GetSmsTemplateResponse

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.sms_template_response.arn #=> String
resp.sms_template_response.body #=> String
resp.sms_template_response.creation_date #=> String
resp.sms_template_response.default_substitutions #=> String
resp.sms_template_response.last_modified_date #=> String
resp.sms_template_response.recommender_id #=> String
resp.sms_template_response.tags #=> Hash
resp.sms_template_response.tags["__string"] #=> String
resp.sms_template_response.template_description #=> String
resp.sms_template_response.template_name #=> String
resp.sms_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.sms_template_response.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



8338
8339
8340
8341
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8338

def get_sms_template(params = {}, options = {})
  req = build_request(:get_sms_template, params)
  req.send_request(options)
end

#get_user_endpoints(params = {}) ⇒ Types::GetUserEndpointsResponse

Retrieves information about all the endpoints that are associated with a specific 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 "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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:

See Also:



8402
8403
8404
8405
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8402

def get_user_endpoints(params = {}, options = {})
  req = build_request(:get_user_endpoints, params)
  req.send_request(options)
end

#get_voice_channel(params = {}) ⇒ Types::GetVoiceChannelResponse

Retrieves information about the status and settings of the voice channel for an application.

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:

See Also:



8439
8440
8441
8442
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8439

def get_voice_channel(params = {}, options = {})
  req = build_request(:get_voice_channel, params)
  req.send_request(options)
end

#get_voice_template(params = {}) ⇒ Types::GetVoiceTemplateResponse

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

Examples:

Request syntax with placeholder values


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

Response structure


resp.voice_template_response.arn #=> String
resp.voice_template_response.body #=> String
resp.voice_template_response.creation_date #=> String
resp.voice_template_response.default_substitutions #=> String
resp.voice_template_response.language_code #=> String
resp.voice_template_response.last_modified_date #=> String
resp.voice_template_response.tags #=> Hash
resp.voice_template_response.tags["__string"] #=> String
resp.voice_template_response.template_description #=> String
resp.voice_template_response.template_name #=> String
resp.voice_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.voice_template_response.version #=> String
resp.voice_template_response.voice_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

Returns:

See Also:



8482
8483
8484
8485
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8482

def get_voice_template(params = {}, options = {})
  req = build_request(:get_voice_template, params)
  req.send_request(options)
end

#list_journeys(params = {}) ⇒ Types::ListJourneysResponse

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

Examples:

Request syntax with placeholder values


resp = client.list_journeys({
  application_id: "__string", # required
  page_size: "__string",
  token: "__string",
})

Response structure


resp.journeys_response.item #=> Array
resp.journeys_response.item[0].activities #=> Hash
resp.journeys_response.item[0].activities["__string"].custom.delivery_uri #=> String
resp.journeys_response.item[0].activities["__string"].custom.endpoint_types #=> Array
resp.journeys_response.item[0].activities["__string"].custom.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.journeys_response.item[0].activities["__string"].custom.message_config.data #=> String
resp.journeys_response.item[0].activities["__string"].custom.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].custom.template_name #=> String
resp.journeys_response.item[0].activities["__string"].custom.template_version #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.event_type.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics #=> Hash
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.dimensions.metrics["__string"].value #=> Float
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].event_condition.message_activity #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_condition.segment_id #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.app_version.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.channel.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.device_type.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.make.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.model.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.demographic.platform.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.country.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics #=> Hash
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].comparison_operator #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.metrics["__string"].value #=> Float
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.conditions[0].segment_dimensions.user_attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.condition.operator #=> String, one of "ALL", "ANY"
resp.journeys_response.item[0].activities["__string"].conditional_split.evaluation_wait_time.wait_for #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.evaluation_wait_time.wait_until #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.false_activity #=> String
resp.journeys_response.item[0].activities["__string"].conditional_split.true_activity #=> String
resp.journeys_response.item[0].activities["__string"].description #=> String
resp.journeys_response.item[0].activities["__string"].email.message_config.from_address #=> String
resp.journeys_response.item[0].activities["__string"].email.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].email.template_name #=> String
resp.journeys_response.item[0].activities["__string"].email.template_version #=> String
resp.journeys_response.item[0].activities["__string"].holdout.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].holdout.percentage #=> Integer
resp.journeys_response.item[0].activities["__string"].multi_condition.branches #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.event_type.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics #=> Hash
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].comparison_operator #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.dimensions.metrics["__string"].value #=> Float
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.event_condition.message_activity #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_condition.segment_id #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.app_version.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.channel.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.device_type.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.make.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.model.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.demographic.platform.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.country.values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.latitude #=> Float
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.coordinates.longitude #=> Float
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.location.gps_point.range_in_kilometers #=> Float
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics #=> Hash
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics["__string"].comparison_operator #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.metrics["__string"].value #=> Float
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes #=> Hash
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].values #=> Array
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].condition.segment_dimensions.user_attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.branches[0].next_activity #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.default_activity #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.evaluation_wait_time.wait_for #=> String
resp.journeys_response.item[0].activities["__string"].multi_condition.evaluation_wait_time.wait_until #=> String
resp.journeys_response.item[0].activities["__string"].push.message_config.time_to_live #=> String
resp.journeys_response.item[0].activities["__string"].push.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].push.template_name #=> String
resp.journeys_response.item[0].activities["__string"].push.template_version #=> String
resp.journeys_response.item[0].activities["__string"].random_split.branches #=> Array
resp.journeys_response.item[0].activities["__string"].random_split.branches[0].next_activity #=> String
resp.journeys_response.item[0].activities["__string"].random_split.branches[0].percentage #=> Integer
resp.journeys_response.item[0].activities["__string"].sms.message_config.message_type #=> String, one of "TRANSACTIONAL", "PROMOTIONAL"
resp.journeys_response.item[0].activities["__string"].sms.message_config.origination_number #=> String
resp.journeys_response.item[0].activities["__string"].sms.message_config.sender_id #=> String
resp.journeys_response.item[0].activities["__string"].sms.message_config.entity_id #=> String
resp.journeys_response.item[0].activities["__string"].sms.message_config.template_id #=> String
resp.journeys_response.item[0].activities["__string"].sms.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].sms.template_name #=> String
resp.journeys_response.item[0].activities["__string"].sms.template_version #=> String
resp.journeys_response.item[0].activities["__string"].wait.next_activity #=> String
resp.journeys_response.item[0].activities["__string"].wait.wait_time.wait_for #=> String
resp.journeys_response.item[0].activities["__string"].wait.wait_time.wait_until #=> String
resp.journeys_response.item[0].activities["__string"].contact_center.next_activity #=> String
resp.journeys_response.item[0].application_id #=> String
resp.journeys_response.item[0].creation_date #=> String
resp.journeys_response.item[0].id #=> String
resp.journeys_response.item[0].last_modified_date #=> String
resp.journeys_response.item[0].limits.daily_cap #=> Integer
resp.journeys_response.item[0].limits.endpoint_reentry_cap #=> Integer
resp.journeys_response.item[0].limits.messages_per_second #=> Integer
resp.journeys_response.item[0].limits.endpoint_reentry_interval #=> String
resp.journeys_response.item[0].limits.timeframe_cap.cap #=> Integer
resp.journeys_response.item[0].limits.timeframe_cap.days #=> Integer
resp.journeys_response.item[0].limits.total_cap #=> Integer
resp.journeys_response.item[0].local_time #=> Boolean
resp.journeys_response.item[0].name #=> String
resp.journeys_response.item[0].quiet_time.end #=> String
resp.journeys_response.item[0].quiet_time.start #=> String
resp.journeys_response.item[0].refresh_frequency #=> String
resp.journeys_response.item[0].schedule.end_time #=> Time
resp.journeys_response.item[0].schedule.start_time #=> Time
resp.journeys_response.item[0].schedule.timezone #=> String
resp.journeys_response.item[0].start_activity #=> String
resp.journeys_response.item[0].start_condition.description #=> String
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.attributes #=> Hash
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].values #=> Array
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.attributes["__string"].values[0] #=> String
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.event_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.event_type.values #=> Array
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.event_type.values[0] #=> String
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.metrics #=> Hash
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.metrics["__string"].comparison_operator #=> String
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.dimensions.metrics["__string"].value #=> Float
resp.journeys_response.item[0].start_condition.event_start_condition.event_filter.filter_type #=> String, one of "SYSTEM", "ENDPOINT"
resp.journeys_response.item[0].start_condition.event_start_condition.segment_id #=> String
resp.journeys_response.item[0].start_condition.segment_start_condition.segment_id #=> String
resp.journeys_response.item[0].state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED", "CANCELLED", "CLOSED", "PAUSED"
resp.journeys_response.item[0].tags #=> Hash
resp.journeys_response.item[0].tags["__string"] #=> String
resp.journeys_response.item[0].wait_for_quiet_time #=> Boolean
resp.journeys_response.item[0].refresh_on_segment_update #=> Boolean
resp.journeys_response.item[0].journey_channel_settings.connect_campaign_arn #=> String
resp.journeys_response.item[0].journey_channel_settings.connect_campaign_execution_role_arn #=> String
resp.journeys_response.item[0].sending_schedule #=> Boolean
resp.journeys_response.item[0].open_hours.email #=> Hash
resp.journeys_response.item[0].open_hours.email["DayOfWeek"] #=> Array
resp.journeys_response.item[0].open_hours.email["DayOfWeek"][0].start_time #=> String
resp.journeys_response.item[0].open_hours.email["DayOfWeek"][0].end_time #=> String
resp.journeys_response.item[0].open_hours.sms #=> Hash
resp.journeys_response.item[0].open_hours.sms["DayOfWeek"] #=> Array
resp.journeys_response.item[0].open_hours.sms["DayOfWeek"][0].start_time #=> String
resp.journeys_response.item[0].open_hours.sms["DayOfWeek"][0].end_time #=> String
resp.journeys_response.item[0].open_hours.push #=> Hash
resp.journeys_response.item[0].open_hours.push["DayOfWeek"] #=> Array
resp.journeys_response.item[0].open_hours.push["DayOfWeek"][0].start_time #=> String
resp.journeys_response.item[0].open_hours.push["DayOfWeek"][0].end_time #=> String
resp.journeys_response.item[0].open_hours.voice #=> Hash
resp.journeys_response.item[0].open_hours.voice["DayOfWeek"] #=> Array
resp.journeys_response.item[0].open_hours.voice["DayOfWeek"][0].start_time #=> String
resp.journeys_response.item[0].open_hours.voice["DayOfWeek"][0].end_time #=> String
resp.journeys_response.item[0].open_hours.custom #=> Hash
resp.journeys_response.item[0].open_hours.custom["DayOfWeek"] #=> Array
resp.journeys_response.item[0].open_hours.custom["DayOfWeek"][0].start_time #=> String
resp.journeys_response.item[0].open_hours.custom["DayOfWeek"][0].end_time #=> String
resp.journeys_response.item[0].closed_days.email #=> Array
resp.journeys_response.item[0].closed_days.email[0].name #=> String
resp.journeys_response.item[0].closed_days.email[0].start_date_time #=> String
resp.journeys_response.item[0].closed_days.email[0].end_date_time #=> String
resp.journeys_response.item[0].closed_days.sms #=> Array
resp.journeys_response.item[0].closed_days.sms[0].name #=> String
resp.journeys_response.item[0].closed_days.sms[0].start_date_time #=> String
resp.journeys_response.item[0].closed_days.sms[0].end_date_time #=> String
resp.journeys_response.item[0].closed_days.push #=> Array
resp.journeys_response.item[0].closed_days.push[0].name #=> String
resp.journeys_response.item[0].closed_days.push[0].start_date_time #=> String
resp.journeys_response.item[0].closed_days.push[0].end_date_time #=> String
resp.journeys_response.item[0].closed_days.voice #=> Array
resp.journeys_response.item[0].closed_days.voice[0].name #=> String
resp.journeys_response.item[0].closed_days.voice[0].start_date_time #=> String
resp.journeys_response.item[0].closed_days.voice[0].end_date_time #=> String
resp.journeys_response.item[0].closed_days.custom #=> Array
resp.journeys_response.item[0].closed_days.custom[0].name #=> String
resp.journeys_response.item[0].closed_days.custom[0].start_date_time #=> String
resp.journeys_response.item[0].closed_days.custom[0].end_date_time #=> String
resp.journeys_response.item[0].timezone_estimation_methods #=> Array
resp.journeys_response.item[0].timezone_estimation_methods[0] #=> String, one of "PHONE_NUMBER", "POSTAL_CODE"
resp.journeys_response.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :page_size (String)
  • :token (String)

Returns:

See Also:



8744
8745
8746
8747
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8744

def list_journeys(params = {}, options = {})
  req = build_request(:list_journeys, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags_model.tags #=> Hash
resp.tags_model.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



8773
8774
8775
8776
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8773

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse

Retrieves information about all the versions of a specific message template.

Examples:

Request syntax with placeholder values


resp = client.list_template_versions({
  next_token: "__string",
  page_size: "__string",
  template_name: "__string", # required
  template_type: "__string", # required
})

Response structure


resp.template_versions_response.item #=> Array
resp.template_versions_response.item[0].creation_date #=> String
resp.template_versions_response.item[0].default_substitutions #=> String
resp.template_versions_response.item[0].last_modified_date #=> String
resp.template_versions_response.item[0].template_description #=> String
resp.template_versions_response.item[0].template_name #=> String
resp.template_versions_response.item[0].template_type #=> String
resp.template_versions_response.item[0].version #=> String
resp.template_versions_response.message #=> String
resp.template_versions_response.next_token #=> String
resp.template_versions_response.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String)
  • :page_size (String)
  • :template_name (required, String)
  • :template_type (required, String)

Returns:

See Also:



8820
8821
8822
8823
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8820

def list_template_versions(params = {}, options = {})
  req = build_request(:list_template_versions, params)
  req.send_request(options)
end

#list_templates(params = {}) ⇒ Types::ListTemplatesResponse

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  next_token: "__string",
  page_size: "__string",
  prefix: "__string",
  template_type: "__string",
})

Response structure


resp.templates_response.item #=> Array
resp.templates_response.item[0].arn #=> String
resp.templates_response.item[0].creation_date #=> String
resp.templates_response.item[0].default_substitutions #=> String
resp.templates_response.item[0].last_modified_date #=> String
resp.templates_response.item[0].tags #=> Hash
resp.templates_response.item[0].tags["__string"] #=> String
resp.templates_response.item[0].template_description #=> String
resp.templates_response.item[0].template_name #=> String
resp.templates_response.item[0].template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH", "INAPP"
resp.templates_response.item[0].version #=> String
resp.templates_response.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String)
  • :page_size (String)
  • :prefix (String)
  • :template_type (String)

Returns:

See Also:



8868
8869
8870
8871
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8868

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#phone_number_validate(params = {}) ⇒ Types::PhoneNumberValidateResponse

Retrieves information about a 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) —

    Specifies a phone number to validate and retrieve information about.

Returns:

See Also:



8912
8913
8914
8915
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8912

def phone_number_validate(params = {}, options = {})
  req = build_request(:phone_number_validate, params)
  req.send_request(options)
end

#put_event_stream(params = {}) ⇒ Types::PutEventStreamResponse

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

Examples:

Request syntax with placeholder values


resp = client.put_event_stream({
  application_id: "__string", # required
  write_event_stream: { # required
    destination_stream_arn: "__string", # required
    role_arn: "__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)
  • :write_event_stream (required, Types::WriteEventStream) —

    Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

Returns:

See Also:



8954
8955
8956
8957
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 8954

def put_event_stream(params = {}, options = {})
  req = build_request(:put_event_stream, params)
  req.send_request(options)
end

#put_events(params = {}) ⇒ Types::PutEventsResponse

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

Examples:

Request syntax with placeholder values


resp = client.put_events({
  application_id: "__string", # required
  events_request: { # required
    batch_item: { # required
      "__string" => {
        endpoint: { # required
          address: "__string",
          attributes: {
            "__string" => ["__string"],
          },
          channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
          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: { # required
          "__string" => {
            app_package_name: "__string",
            app_title: "__string",
            app_version_code: "__string",
            attributes: {
              "__string" => "__string",
            },
            client_sdk_version: "__string",
            event_type: "__string", # required
            metrics: {
              "__string" => 1.0,
            },
            sdk_name: "__string",
            session: {
              duration: 1,
              id: "__string", # required
              start_timestamp: "__string", # required
              stop_timestamp: "__string",
            },
            timestamp: "__string", # required
          },
        },
      },
    },
  },
})

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) —

    Specifies a batch of events to process.

Returns:

See Also:



9057
9058
9059
9060
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9057

def put_events(params = {}, options = {})
  req = build_request(:put_events, params)
  req.send_request(options)
end

#remove_attributes(params = {}) ⇒ Types::RemoveAttributesResponse

Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

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) —

    Specifies one or more attributes to remove from all the endpoints that are associated with an application.

Returns:

See Also:



9100
9101
9102
9103
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9100

def remove_attributes(params = {}, options = {})
  req = build_request(:remove_attributes, params)
  req.send_request(options)
end

#send_messages(params = {}) ⇒ Types::SendMessagesResponse

Creates and sends 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: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
        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: { # required
      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: {
        apns_push_type: "__string",
        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",
          },
          headers: [
            {
              name: "__string",
              value: "__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",
        preferred_authentication_method: "__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",
        media_url: "__string",
        message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
        origination_number: "__string",
        sender_id: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        entity_id: "__string",
        template_id: "__string",
      },
      voice_message: {
        body: "__string",
        language_code: "__string",
        origination_number: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        voice_id: "__string",
      },
    },
    template_configuration: {
      email_template: {
        name: "__string",
        version: "__string",
      },
      push_template: {
        name: "__string",
        version: "__string",
      },
      sms_template: {
        name: "__string",
        version: "__string",
      },
      voice_template: {
        name: "__string",
        version: "__string",
      },
      in_app_template: {
        name: "__string",
        version: "__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) —

    Specifies the configuration and other settings for a message.

Returns:

See Also:



9364
9365
9366
9367
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9364

def send_messages(params = {}, options = {})
  req = build_request(:send_messages, params)
  req.send_request(options)
end

#send_otp_message(params = {}) ⇒ Types::SendOTPMessageResponse

Send an OTP message

Examples:

Request syntax with placeholder values


resp = client.send_otp_message({
  application_id: "__string", # required
  send_otp_message_request_parameters: { # required
    allowed_attempts: 1,
    brand_name: "__string", # required
    channel: "__string", # required
    code_length: 1,
    destination_identity: "__string", # required
    entity_id: "__string",
    language: "__string",
    origination_identity: "__string", # required
    reference_id: "__string", # required
    template_id: "__string",
    validity_period: 1,
  },
})

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):

Returns:

See Also:



9421
9422
9423
9424
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9421

def send_otp_message(params = {}, options = {})
  req = build_request(:send_otp_message, params)
  req.send_request(options)
end

#send_users_messages(params = {}) ⇒ Types::SendUsersMessagesResponse

Creates and sends 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: { # required
      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: {
        apns_push_type: "__string",
        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",
          },
          headers: [
            {
              name: "__string",
              value: "__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",
        preferred_authentication_method: "__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",
        media_url: "__string",
        message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
        origination_number: "__string",
        sender_id: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        entity_id: "__string",
        template_id: "__string",
      },
      voice_message: {
        body: "__string",
        language_code: "__string",
        origination_number: "__string",
        substitutions: {
          "__string" => ["__string"],
        },
        voice_id: "__string",
      },
    },
    template_configuration: {
      email_template: {
        name: "__string",
        version: "__string",
      },
      push_template: {
        name: "__string",
        version: "__string",
      },
      sms_template: {
        name: "__string",
        version: "__string",
      },
      voice_template: {
        name: "__string",
        version: "__string",
      },
      in_app_template: {
        name: "__string",
        version: "__string",
      },
    },
    trace_id: "__string",
    users: { # required
      "__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) —

    Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

Returns:

See Also:



9667
9668
9669
9670
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9667

def send_users_messages(params = {}, options = {})
  req = build_request(:send_users_messages, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags_model: { # required
    tags: { # required
      "__string" => "__string",
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags_model (required, Types::TagsModel) —

    Specifies the tags (keys and values) for an application, campaign, message template, or segment.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9698
9699
9700
9701
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9698

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9723
9724
9725
9726
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9723

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_adm_channel(params = {}) ⇒ Types::UpdateAdmChannelResponse

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

Examples:

Request syntax with placeholder values


resp = client.update_adm_channel({
  adm_channel_request: { # required
    client_id: "__string", # required
    client_secret: "__string", # required
    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) —

    Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

  • :application_id (required, String)

Returns:

See Also:



9769
9770
9771
9772
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9769

def update_adm_channel(params = {}, options = {})
  req = build_request(:update_adm_channel, params)
  req.send_request(options)
end

#update_apns_channel(params = {}) ⇒ Types::UpdateApnsChannelResponse

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

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) —

    Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

  • :application_id (required, String)

Returns:

See Also:



9822
9823
9824
9825
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9822

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

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

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) —

    Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

  • :application_id (required, String)

Returns:

See Also:



9875
9876
9877
9878
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9875

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

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

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) —

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

  • :application_id (required, String)

Returns:

See Also:



9928
9929
9930
9931
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9928

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

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

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) —

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

  • :application_id (required, String)

Returns:

See Also:



9982
9983
9984
9985
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 9982

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

Updates the settings for an application.

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,
      session: 1,
    },
    quiet_time: {
      end: "__string",
      start: "__string",
    },
    journey_limits: {
      daily_cap: 1,
      timeframe_cap: {
        cap: 1,
        days: 1,
      },
      total_cap: 1,
    },
  },
})

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.limits.session #=> Integer
resp.application_settings_resource.quiet_time.end #=> String
resp.application_settings_resource.quiet_time.start #=> String
resp.application_settings_resource.journey_limits.daily_cap #=> Integer
resp.application_settings_resource.journey_limits.timeframe_cap.cap #=> Integer
resp.application_settings_resource.journey_limits.timeframe_cap.days #=> Integer
resp.application_settings_resource.journey_limits.total_cap #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



10054
10055
10056
10057
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 10054

def update_application_settings(params = {}, options = {})
  req = build_request(:update_application_settings, params)
  req.send_request(options)
end

#update_baidu_channel(params = {}) ⇒ Types::UpdateBaiduChannelResponse

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

Examples:

Request syntax with placeholder values


resp = client.update_baidu_channel({
  application_id: "__string", # required
  baidu_channel_request: { # required
    api_key: "__string", # required
    enabled: false,
    secret_key: "__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)
  • :baidu_channel_request (required, Types::BaiduChannelRequest) —

    Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Returns:

See Also:



10101
10102
10103
10104
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 10101

def update_baidu_channel(params = {}, options = {})
  req = build_request(:update_baidu_channel, params)
  req.send_request(options)
end

#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse

Updates the configuration and other settings for 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: [
      {
        custom_delivery_configuration: {
          delivery_uri: "__string", # required
          endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
        },
        message_configuration: {
          adm_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          apns_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          baidu_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          custom_message: {
            data: "__string",
          },
          default_message: {
            action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
            body: "__string",
            image_icon_url: "__string",
            image_small_icon_url: "__string",
            image_url: "__string",
            json_body: "__string",
            media_url: "__string",
            raw_content: "__string",
            silent_push: false,
            time_to_live: 1,
            title: "__string",
            url: "__string",
          },
          email_message: {
            body: "__string",
            from_address: "__string",
            headers: [
              {
                name: "__string",
                value: "__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
            origination_number: "__string",
            sender_id: "__string",
            entity_id: "__string",
            template_id: "__string",
          },
          in_app_message: {
            body: "__string",
            content: [
              {
                background_color: "__string",
                body_config: {
                  alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
                  body: "__string", # required
                  text_color: "__string", # required
                },
                header_config: {
                  alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
                  header: "__string", # required
                  text_color: "__string", # required
                },
                image_url: "__string",
                primary_btn: {
                  android: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  default_config: {
                    background_color: "__string",
                    border_radius: 1,
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                    text: "__string", # required
                    text_color: "__string",
                  },
                  ios: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  web: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                },
                secondary_btn: {
                  android: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  default_config: {
                    background_color: "__string",
                    border_radius: 1,
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                    text: "__string", # required
                    text_color: "__string",
                  },
                  ios: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                  web: {
                    button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                    link: "__string",
                  },
                },
              },
            ],
            custom_config: {
              "__string" => "__string",
            },
            layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
          },
        },
        schedule: {
          end_time: "__string",
          event_filter: {
            dimensions: { # required
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
                  values: ["__string"], # required
                },
              },
              event_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
            },
            filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
          },
          frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
          is_local_time: false,
          quiet_time: {
            end: "__string",
            start: "__string",
          },
          start_time: "__string", # required
          timezone: "__string",
        },
        size_percent: 1, # required
        template_configuration: {
          email_template: {
            name: "__string",
            version: "__string",
          },
          push_template: {
            name: "__string",
            version: "__string",
          },
          sms_template: {
            name: "__string",
            version: "__string",
          },
          voice_template: {
            name: "__string",
            version: "__string",
          },
          in_app_template: {
            name: "__string",
            version: "__string",
          },
        },
        treatment_description: "__string",
        treatment_name: "__string",
      },
    ],
    custom_delivery_configuration: {
      delivery_uri: "__string", # required
      endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
    },
    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,
      session: 1,
    },
    message_configuration: {
      adm_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      apns_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      baidu_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      custom_message: {
        data: "__string",
      },
      default_message: {
        action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
        body: "__string",
        image_icon_url: "__string",
        image_small_icon_url: "__string",
        image_url: "__string",
        json_body: "__string",
        media_url: "__string",
        raw_content: "__string",
        silent_push: false,
        time_to_live: 1,
        title: "__string",
        url: "__string",
      },
      email_message: {
        body: "__string",
        from_address: "__string",
        headers: [
          {
            name: "__string",
            value: "__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
        origination_number: "__string",
        sender_id: "__string",
        entity_id: "__string",
        template_id: "__string",
      },
      in_app_message: {
        body: "__string",
        content: [
          {
            background_color: "__string",
            body_config: {
              alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
              body: "__string", # required
              text_color: "__string", # required
            },
            header_config: {
              alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
              header: "__string", # required
              text_color: "__string", # required
            },
            image_url: "__string",
            primary_btn: {
              android: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              default_config: {
                background_color: "__string",
                border_radius: 1,
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
                text: "__string", # required
                text_color: "__string",
              },
              ios: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              web: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
            },
            secondary_btn: {
              android: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              default_config: {
                background_color: "__string",
                border_radius: 1,
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
                text: "__string", # required
                text_color: "__string",
              },
              ios: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
              web: {
                button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
                link: "__string",
              },
            },
          },
        ],
        custom_config: {
          "__string" => "__string",
        },
        layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
      },
    },
    name: "__string",
    schedule: {
      end_time: "__string",
      event_filter: {
        dimensions: { # required
          attributes: {
            "__string" => {
              attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
              values: ["__string"], # required
            },
          },
          event_type: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          metrics: {
            "__string" => {
              comparison_operator: "__string", # required
              value: 1.0, # required
            },
          },
        },
        filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
      },
      frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
      is_local_time: false,
      quiet_time: {
        end: "__string",
        start: "__string",
      },
      start_time: "__string", # required
      timezone: "__string",
    },
    segment_id: "__string",
    segment_version: 1,
    tags: {
      "__string" => "__string",
    },
    template_configuration: {
      email_template: {
        name: "__string",
        version: "__string",
      },
      push_template: {
        name: "__string",
        version: "__string",
      },
      sms_template: {
        name: "__string",
        version: "__string",
      },
      voice_template: {
        name: "__string",
        version: "__string",
      },
      in_app_template: {
        name: "__string",
        version: "__string",
      },
    },
    treatment_description: "__string",
    treatment_name: "__string",
    priority: 1,
  },
})

Response structure


resp.campaign_response.additional_treatments #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
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.custom_message.data #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.raw_content #=> String
resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.additional_treatments[0].message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.sender_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.entity_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.sms_message.template_id #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content #=> Array
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.additional_treatments[0].message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.email_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.push_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.sms_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.voice_template.version #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.name #=> String
resp.campaign_response.additional_treatments[0].template_configuration.in_app_template.version #=> String
resp.campaign_response.additional_treatments[0].treatment_description #=> String
resp.campaign_response.additional_treatments[0].treatment_name #=> String
resp.campaign_response.application_id #=> String
resp.campaign_response.arn #=> String
resp.campaign_response.creation_date #=> String
resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "PUSH", "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM", "IN_APP"
resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED", "INVALID"
resp.campaign_response.description #=> String
resp.campaign_response.holdout_percent #=> Integer
resp.campaign_response.hook.lambda_function_name #=> String
resp.campaign_response.hook.mode #=> String, one of "DELIVERY", "FILTER"
resp.campaign_response.hook.web_url #=> String
resp.campaign_response.id #=> String
resp.campaign_response.is_paused #=> 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.limits.session #=> 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.custom_message.data #=> String
resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
resp.campaign_response.message_configuration.default_message.body #=> String
resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_small_icon_url #=> String
resp.campaign_response.message_configuration.default_message.image_url #=> String
resp.campaign_response.message_configuration.default_message.json_body #=> String
resp.campaign_response.message_configuration.default_message.media_url #=> String
resp.campaign_response.message_configuration.default_message.raw_content #=> String
resp.campaign_response.message_configuration.default_message.silent_push #=> 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.headers #=> Array
resp.campaign_response.message_configuration.email_message.headers[0].name #=> String
resp.campaign_response.message_configuration.email_message.headers[0].value #=> 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.origination_number #=> String
resp.campaign_response.message_configuration.sms_message.sender_id #=> String
resp.campaign_response.message_configuration.sms_message.entity_id #=> String
resp.campaign_response.message_configuration.sms_message.template_id #=> String
resp.campaign_response.message_configuration.in_app_message.body #=> String
resp.campaign_response.message_configuration.in_app_message.content #=> Array
resp.campaign_response.message_configuration.in_app_message.content[0].background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.body #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].body_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.alignment #=> String, one of "LEFT", "CENTER", "RIGHT"
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.header #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].header_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].image_url #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].primary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.android.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.background_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.border_radius #=> Integer
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.default_config.text_color #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.ios.link #=> String
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.button_action #=> String, one of "LINK", "DEEP_LINK", "CLOSE"
resp.campaign_response.message_configuration.in_app_message.content[0].secondary_btn.web.link #=> String
resp.campaign_response.message_configuration.in_app_message.custom_config #=> Hash
resp.campaign_response.message_configuration.in_app_message.custom_config["__string"] #=> String
resp.campaign_response.message_configuration.in_app_message.layout #=> String, one of "BOTTOM_BANNER", "TOP_BANNER", "OVERLAYS", "MOBILE_FEED", "MIDDLE_BANNER", "CAROUSEL"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "IN_APP_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", "INVALID"
resp.campaign_response.tags #=> Hash
resp.campaign_response.tags["__string"] #=> String
resp.campaign_response.template_configuration.email_template.name #=> String
resp.campaign_response.template_configuration.email_template.version #=> String
resp.campaign_response.template_configuration.push_template.name #=> String
resp.campaign_response.template_configuration.push_template.version #=> String
resp.campaign_response.template_configuration.sms_template.name #=> String
resp.campaign_response.template_configuration.sms_template.version #=> String
resp.campaign_response.template_configuration.voice_template.name #=> String
resp.campaign_response.template_configuration.voice_template.version #=> String
resp.campaign_response.template_configuration.in_app_template.name #=> String
resp.campaign_response.template_configuration.in_app_template.version #=> String
resp.campaign_response.treatment_description #=> String
resp.campaign_response.treatment_name #=> String
resp.campaign_response.version #=> Integer
resp.campaign_response.priority #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :campaign_id (required, String)
  • :write_campaign_request (required, Types::WriteCampaignRequest) —

    Specifies the configuration and other settings for a campaign.

Returns:

See Also:



10923
10924
10925
10926
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 10923

def update_campaign(params = {}, options = {})
  req = build_request(:update_campaign, params)
  req.send_request(options)
end

#update_email_channel(params = {}) ⇒ Types::UpdateEmailChannelResponse

Enables the email channel for an application or updates the status and settings of the email channel for an application.

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", # required
    identity: "__string", # required
    role_arn: "__string",
    orchestration_sending_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.orchestration_sending_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) —

    Specifies the status and settings of the email channel for an application.

Returns:

See Also:



10978
10979
10980
10981
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 10978

def update_email_channel(params = {}, options = {})
  req = build_request(:update_email_channel, params)
  req.send_request(options)
end

#update_email_template(params = {}) ⇒ Types::UpdateEmailTemplateResponse

Updates an existing message template for messages that are sent through the email channel.

Examples:

Request syntax with placeholder values


resp = client.update_email_template({
  create_new_version: false,
  email_template_request: { # required
    default_substitutions: "__string",
    html_part: "__string",
    recommender_id: "__string",
    subject: "__string",
    headers: [
      {
        name: "__string",
        value: "__string",
      },
    ],
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
    text_part: "__string",
  },
  template_name: "__string", # required
  version: "__string",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_new_version (Boolean)
  • :email_template_request (required, Types::EmailTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

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

Returns:

See Also:



11034
11035
11036
11037
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 11034

def update_email_template(params = {}, options = {})
  req = build_request(:update_email_template, params)
  req.send_request(options)
end

#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

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: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
    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) —

    Specifies the channel type and other settings for an endpoint.

Returns:

See Also:



11111
11112
11113
11114
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 11111

def update_endpoint(params = {}, options = {})
  req = build_request(:update_endpoint, params)
  req.send_request(options)
end

#update_endpoints_batch(params = {}) ⇒ Types::UpdateEndpointsBatchResponse

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

Examples:

Request syntax with placeholder values


resp = client.update_endpoints_batch({
  application_id: "__string", # required
  endpoint_batch_request: { # required
    item: [ # required
      {
        address: "__string",
        attributes: {
          "__string" => ["__string"],
        },
        channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
        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) —

    Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

Returns:

See Also:



11191
11192
11193
11194
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 11191

def update_endpoints_batch(params = {}, options = {})
  req = build_request(:update_endpoints_batch, params)
  req.send_request(options)
end

#update_gcm_channel(params = {}) ⇒ Types::UpdateGcmChannelResponse

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Examples:

Request syntax with placeholder values


resp = client.update_gcm_channel({
  application_id: "__string", # required
  gcm_channel_request: { # required
    api_key: "__string",
    default_authentication_method: "__string",
    enabled: false,
    service_json: "__string",
  },
})

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.default_authentication_method #=> String
resp.gcm_channel_response.enabled #=> Boolean
resp.gcm_channel_response.has_credential #=> Boolean
resp.gcm_channel_response.has_fcm_service_credentials #=> 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) —

    Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

Returns:

See Also:



11243
11244
11245
11246
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 11243

def update_gcm_channel(params = {}, options = {})
  req = build_request(:update_gcm_channel, params)
  req.send_request(options)
end

#update_in_app_template(params = {}) ⇒ Types::UpdateInAppTemplateResponse

Updates an existing message template for messages sent through the in-app message channel.

Examples:

Request syntax with placeholder values


resp = client.update_in_app_template({
  create_new_version: false,
  in_app_template_request: { # required
    content: [
      {
        background_color: "__string",
        body_config: {
          alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
          body: "__string", # required
          text_color: "__string", # required
        },
        header_config: {
          alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
          header: "__string", # required
          text_color: "__string", # required
        },
        image_url: "__string",
        primary_btn: {
          android: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          default_config: {
            background_color: "__string",
            border_radius: 1,
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
            text: "__string", # required
            text_color: "__string",
          },
          ios: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          web: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
        },
        secondary_btn: {
          android: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          default_config: {
            background_color: "__string",
            border_radius: 1,
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
            text: "__string", # required
            text_color: "__string",
          },
          ios: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
          web: {
            button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
            link: "__string",
          },
        },
      },
    ],
    custom_config: {
      "__string" => "__string",
    },
    layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
    tags: {
      "__string" => "__string",
    },
    template_description: "__string",
  },
  template_name: "__string", # required
  version: "__string",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_new_version (Boolean)
  • :in_app_template_request (required, Types::InAppTemplateRequest) —

    In-App Template Request.

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

Returns:

See Also:



11351
11352
11353
11354
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 11351

def update_in_app_template(params = {}, options = {})
  req = build_request(:update_in_app_template, params)
  req.send_request(options)
end

#update_journey(params = {}) ⇒ Types::UpdateJourneyResponse

Updates the configuration and other settings for a journey.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)
  • :write_journey_request (required, Types::WriteJourneyRequest) —

    Specifies the configuration and other settings for a journey.

Returns:

See Also:



12028
12029
12030
12031
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12028

def update_journey(params = {}, options = {})
  req = build_request(:update_journey, params)
  req.send_request(options)
end

#update_journey_state(params = {}) ⇒ Types::UpdateJourneyStateResponse

Pause, resume or cancels (stops) a journey.

Examples:

Request syntax with placeholder values


resp = client.update_journey_state({
  application_id: "__string", # required
  journey_id: "__string", # required
  journey_state_request: { # required
    state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
  },
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :journey_id (required, String)
  • :journey_state_request (required, Types::JourneyStateRequest) —

    Changes the status of a journey.

Returns:

See Also:



12290
12291
12292
12293
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12290

def update_journey_state(params = {}, options = {})
  req = build_request(:update_journey_state, params)
  req.send_request(options)
end

#update_push_template(params = {}) ⇒ Types::UpdatePushTemplateResponse

Updates an existing message template for messages that are sent through a push notification channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_new_version (Boolean)
  • :push_notification_template_request (required, Types::PushNotificationTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

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

Returns:

See Also:



12386
12387
12388
12389
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12386

def update_push_template(params = {}, options = {})
  req = build_request(:update_push_template, params)
  req.send_request(options)
end

#update_recommender_configuration(params = {}) ⇒ Types::UpdateRecommenderConfigurationResponse

Updates an Amazon Pinpoint configuration for a recommender model.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recommender_id (required, String)
  • :update_recommender_configuration (required, Types::UpdateRecommenderConfiguration) —

    Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Returns:

See Also:



12442
12443
12444
12445
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12442

def update_recommender_configuration(params = {}, options = {})
  req = build_request(:update_recommender_configuration, params)
  req.send_request(options)
end

#update_segment(params = {}) ⇒ Types::UpdateSegmentResponse

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

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, CONTAINS, BEFORE, AFTER, BETWEEN, ON
          values: ["__string"], # required
        },
      },
      behavior: {
        recency: {
          duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
          recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
        },
      },
      demographic: {
        app_version: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        channel: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        device_type: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        make: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        model: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        platform: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
      },
      location: {
        country: {
          dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
          values: ["__string"], # required
        },
        gps_point: {
          coordinates: { # required
            latitude: 1.0, # required
            longitude: 1.0, # required
          },
          range_in_kilometers: 1.0,
        },
      },
      metrics: {
        "__string" => {
          comparison_operator: "__string", # required
          value: 1.0, # required
        },
      },
      user_attributes: {
        "__string" => {
          attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
          values: ["__string"], # required
        },
      },
    },
    name: "__string",
    segment_groups: {
      groups: [
        {
          dimensions: [
            {
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
                  values: ["__string"], # required
                },
              },
              behavior: {
                recency: {
                  duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                  recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
                },
              },
              demographic: {
                app_version: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                channel: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                device_type: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                make: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                model: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                platform: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              location: {
                country: {
                  dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
                gps_point: {
                  coordinates: { # required
                    latitude: 1.0, # required
                    longitude: 1.0, # required
                  },
                  range_in_kilometers: 1.0,
                },
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
              user_attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
                  values: ["__string"], # required
                },
              },
            },
          ],
          source_segments: [
            {
              id: "__string", # required
              version: 1,
            },
          ],
          source_type: "ALL", # accepts ALL, ANY, NONE
          type: "ALL", # accepts ALL, ANY, NONE
        },
      ],
      include: "ALL", # accepts ALL, ANY, NONE
    },
    tags: {
      "__string" => "__string",
    },
  },
})

Response structure


resp.segment_response.application_id #=> String
resp.segment_response.arn #=> String
resp.segment_response.creation_date #=> String
resp.segment_response.dimensions.attributes #=> Hash
resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
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", "CONTAINS", "BEFORE", "AFTER", "BETWEEN", "ON"
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values #=> Array
resp.segment_response.segment_groups.groups[0].dimensions[0].user_attributes["__string"].values[0] #=> String
resp.segment_response.segment_groups.groups[0].source_segments #=> Array
resp.segment_response.segment_groups.groups[0].source_segments[0].id #=> String
resp.segment_response.segment_groups.groups[0].source_segments[0].version #=> Integer
resp.segment_response.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
resp.segment_response.tags #=> Hash
resp.segment_response.tags["__string"] #=> String
resp.segment_response.version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :segment_id (required, String)
  • :write_segment_request (required, Types::WriteSegmentRequest) —

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

Returns:

See Also:



12730
12731
12732
12733
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12730

def update_segment(params = {}, options = {})
  req = build_request(:update_segment, params)
  req.send_request(options)
end

#update_sms_channel(params = {}) ⇒ Types::UpdateSmsChannelResponse

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

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) —

    Specifies the status and settings of the SMS channel for an application.

Returns:

See Also:



12780
12781
12782
12783
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12780

def update_sms_channel(params = {}, options = {})
  req = build_request(:update_sms_channel, params)
  req.send_request(options)
end

#update_sms_template(params = {}) ⇒ Types::UpdateSmsTemplateResponse

Updates an existing message template for messages that are sent through the SMS channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_new_version (Boolean)
  • :sms_template_request (required, Types::SMSTemplateRequest) —

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

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

Returns:

See Also:



12828
12829
12830
12831
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12828

def update_sms_template(params = {}, options = {})
  req = build_request(:update_sms_template, params)
  req.send_request(options)
end

#update_template_active_version(params = {}) ⇒ Types::UpdateTemplateActiveVersionResponse

Changes the status of a specific version of a message template to active.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_active_version_request (required, Types::TemplateActiveVersionRequest) —

    Specifies which version of a message template to use as the active version of the template.

  • :template_name (required, String)
  • :template_type (required, String)

Returns:

See Also:



12867
12868
12869
12870
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12867

def update_template_active_version(params = {}, options = {})
  req = build_request(:update_template_active_version, params)
  req.send_request(options)
end

#update_voice_channel(params = {}) ⇒ Types::UpdateVoiceChannelResponse

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

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) —

    Specifies the status and settings of the voice channel for an application.

Returns:

See Also:



12911
12912
12913
12914
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12911

def update_voice_channel(params = {}, options = {})
  req = build_request(:update_voice_channel, params)
  req.send_request(options)
end

#update_voice_template(params = {}) ⇒ Types::UpdateVoiceTemplateResponse

Updates an existing message template for messages that are sent through the voice channel.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :create_new_version (Boolean)
  • :template_name (required, String)
  • :version (String)
  • :voice_template_request (required, Types::VoiceTemplateRequest) —

    Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Returns:

See Also:



12960
12961
12962
12963
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12960

def update_voice_template(params = {}, options = {})
  req = build_request(:update_voice_template, params)
  req.send_request(options)
end

#verify_otp_message(params = {}) ⇒ Types::VerifyOTPMessageResponse

Verify an OTP

Examples:

Request syntax with placeholder values


resp = client.verify_otp_message({
  application_id: "__string", # required
  verify_otp_message_request_parameters: { # required
    destination_identity: "__string", # required
    otp: "__string", # required
    reference_id: "__string", # required
  },
})

Response structure


resp.verification_response.valid #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



12995
12996
12997
12998
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 12995

def verify_otp_message(params = {}, options = {})
  req = build_request(:verify_otp_message, 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.

Deprecated. 


13024
13025
13026
 
# File 'lib/aws-sdk-pinpoint/client.rb', line 13024

def waiter_names
  []
end