aws-sdk-pinpoint 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c4e3a23291e7295d5c030e2eaec5770af6cbe14
-  data.tar.gz: c11e7e10df64fb8590c672b1be427b57f004bbaf
+  metadata.gz: 94e01c71484d5bd5b9c6112abb306f5caf3642a3
+  data.tar.gz: f86111a0348617f6496d4f07a168337f6b20b5b7
 SHA512:
-  metadata.gz: c7b975aed8e5eba06ed86ec6e1e52cfbd8adeafdb105eda521024cd16c14a626ff7e366c92d65ab2b6908e13d970509fe528f7350baa0f2373ed49580a2ec5ca
-  data.tar.gz: c52f6e392b572144625b2094250c233d07b65e86d0a16f1f45643e21c037197d89b520e07523a3e5342bb41643e2d47a5e24826c4755ae80a229e3f6e2facf52
+  metadata.gz: 11de79aa56532929d67b9238457be610f2d77dea6f4e6f1f7b9c222700d603e83102b4170de67d19270d33db67b9fd1359f19a6ee263a83e749cd7075b4e11d6
+  data.tar.gz: a11f2bc603ba6e9d44724b822039bd08a220a0d4c5505fb811517aceba059d24ea05210eaaf3018cbf4dd74a9fa7a7c1b9e34839bb6b5baacefc10364a7f4f53

data/lib/aws-sdk-pinpoint.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-pinpoint/customizations'
 # @service
 module Aws::Pinpoint
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end

data/lib/aws-sdk-pinpoint/client.rb

@@ -290,6 +290,11 @@ module Aws::Pinpoint
     #       ],
     #       description: "__string",
     #       holdout_percent: 1,
+    #       hook: {
+    #         lambda_function_name: "__string",
+    #         mode: "DELIVERY", # accepts DELIVERY, FILTER
+    #         web_url: "__string",
+    #       },
     #       is_paused: false,
     #       limits: {
     #         daily: 1,
@@ -476,6 +481,9 @@ module Aws::Pinpoint
     #   resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -569,6 +577,55 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
+    # Creates an export job.
+    #
+    # @option params [required, String] :application_id
+    #
+    # @option params [required, Types::ExportJobRequest] :export_job_request
+    #
+    # @return [Types::CreateExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateExportJobResponse#export_job_response #export_job_response} => Types::ExportJobResponse
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_export_job({
+    #     application_id: "__string", # required
+    #     export_job_request: { # required
+    #       role_arn: "__string",
+    #       s3_url_prefix: "__string",
+    #       segment_id: "__string",
+    #     },
+    #   })
+    #
+    # @example 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.failed_pieces #=> Integer
+    #   resp.export_job_response.failures #=> Array
+    #   resp.export_job_response.failures[0] #=> String
+    #   resp.export_job_response.id #=> String
+    #   resp.export_job_response.job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
+    #   resp.export_job_response.total_failures #=> Integer
+    #   resp.export_job_response.total_pieces #=> Integer
+    #   resp.export_job_response.total_processed #=> Integer
+    #   resp.export_job_response.type #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJob AWS API Documentation
+    #
+    # @overload create_export_job(params = {})
+    # @param [Hash] params ({})
+    def create_export_job(params = {}, options = {})
+      req = build_request(:create_export_job, params)
+      req.send_request(options)
+    end
+
     # Creates or updates an import job.
     #
     # @option params [required, String] :application_id
@@ -869,7 +926,7 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Delete an APNS VOIP channel
+    # Delete an APNS VoIP channel
     #
     # @option params [required, String] :application_id
     #
@@ -907,7 +964,7 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Delete an APNS VOIP sandbox channel
+    # Delete an APNS VoIP sandbox channel
     #
     # @option params [required, String] :application_id
     #
@@ -1109,6 +1166,9 @@ module Aws::Pinpoint
     #   resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -1535,7 +1595,7 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Get an APNS Voip channel
+    # Get an APNS VoIP channel
     #
     # @option params [required, String] :application_id
     #
@@ -1573,7 +1633,7 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Get an APNS VoipSandbox channel
+    # Get an APNS VoIPSandbox channel
     #
     # @option params [required, String] :application_id
     #
@@ -1656,6 +1716,9 @@ module Aws::Pinpoint
     # @example 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
@@ -1842,6 +1905,9 @@ module Aws::Pinpoint
     #   resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -2086,6 +2152,9 @@ module Aws::Pinpoint
     #   resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -2285,6 +2354,9 @@ module Aws::Pinpoint
     #   resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -2482,6 +2554,9 @@ module Aws::Pinpoint
     #   resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -2639,7 +2714,7 @@ module Aws::Pinpoint
     #   resp.endpoint_response.attributes #=> Hash
     #   resp.endpoint_response.attributes["__string"] #=> Array
     #   resp.endpoint_response.attributes["__string"][0] #=> String
-    #   resp.endpoint_response.channel_type #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL", "BAIDU"
+    #   resp.endpoint_response.channel_type #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL", "BAIDU", "CUSTOM"
     #   resp.endpoint_response.cohort_id #=> String
     #   resp.endpoint_response.creation_date #=> String
     #   resp.endpoint_response.demographic.app_version #=> String
@@ -2710,6 +2785,101 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
+    # Returns information about an export job.
+    #
+    # @option params [required, String] :application_id
+    #
+    # @option params [required, String] :job_id
+    #
+    # @return [Types::GetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetExportJobResponse#export_job_response #export_job_response} => Types::ExportJobResponse
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_export_job({
+    #     application_id: "__string", # required
+    #     job_id: "__string", # required
+    #   })
+    #
+    # @example 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.failed_pieces #=> Integer
+    #   resp.export_job_response.failures #=> Array
+    #   resp.export_job_response.failures[0] #=> String
+    #   resp.export_job_response.id #=> String
+    #   resp.export_job_response.job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
+    #   resp.export_job_response.total_failures #=> Integer
+    #   resp.export_job_response.total_pieces #=> Integer
+    #   resp.export_job_response.total_processed #=> Integer
+    #   resp.export_job_response.type #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJob AWS API Documentation
+    #
+    # @overload get_export_job(params = {})
+    # @param [Hash] params ({})
+    def get_export_job(params = {}, options = {})
+      req = build_request(:get_export_job, params)
+      req.send_request(options)
+    end
+
+    # Returns information about your export jobs.
+    #
+    # @option params [required, String] :application_id
+    #
+    # @option params [String] :page_size
+    #
+    # @option params [String] :token
+    #
+    # @return [Types::GetExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetExportJobsResponse#export_jobs_response #export_jobs_response} => Types::ExportJobsResponse
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_export_jobs({
+    #     application_id: "__string", # required
+    #     page_size: "__string",
+    #     token: "__string",
+    #   })
+    #
+    # @example 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].failed_pieces #=> Integer
+    #   resp.export_jobs_response.item[0].failures #=> Array
+    #   resp.export_jobs_response.item[0].failures[0] #=> String
+    #   resp.export_jobs_response.item[0].id #=> String
+    #   resp.export_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
+    #   resp.export_jobs_response.item[0].total_failures #=> Integer
+    #   resp.export_jobs_response.item[0].total_pieces #=> Integer
+    #   resp.export_jobs_response.item[0].total_processed #=> Integer
+    #   resp.export_jobs_response.item[0].type #=> String
+    #   resp.export_jobs_response.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJobs AWS API Documentation
+    #
+    # @overload get_export_jobs(params = {})
+    # @param [Hash] params ({})
+    def get_export_jobs(params = {}, options = {})
+      req = build_request(:get_export_jobs, params)
+      req.send_request(options)
+    end
+
     # Returns information about the GCM channel for an app.
     #
     # @option params [required, String] :application_id
@@ -2926,6 +3096,59 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
+    # Returns a list of export jobs for a specific segment.
+    #
+    # @option params [required, String] :application_id
+    #
+    # @option params [String] :page_size
+    #
+    # @option params [required, String] :segment_id
+    #
+    # @option params [String] :token
+    #
+    # @return [Types::GetSegmentExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetSegmentExportJobsResponse#export_jobs_response #export_jobs_response} => Types::ExportJobsResponse
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_segment_export_jobs({
+    #     application_id: "__string", # required
+    #     page_size: "__string",
+    #     segment_id: "__string", # required
+    #     token: "__string",
+    #   })
+    #
+    # @example 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].failed_pieces #=> Integer
+    #   resp.export_jobs_response.item[0].failures #=> Array
+    #   resp.export_jobs_response.item[0].failures[0] #=> String
+    #   resp.export_jobs_response.item[0].id #=> String
+    #   resp.export_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
+    #   resp.export_jobs_response.item[0].total_failures #=> Integer
+    #   resp.export_jobs_response.item[0].total_pieces #=> Integer
+    #   resp.export_jobs_response.item[0].total_processed #=> Integer
+    #   resp.export_jobs_response.item[0].type #=> String
+    #   resp.export_jobs_response.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentExportJobs AWS API Documentation
+    #
+    # @overload get_segment_export_jobs(params = {})
+    # @param [Hash] params ({})
+    def get_segment_export_jobs(params = {}, options = {})
+      req = build_request(:get_segment_export_jobs, params)
+      req.send_request(options)
+    end
+
     # Returns a list of import jobs for a specific segment.
     #
     # @option params [required, String] :application_id
@@ -3319,7 +3542,7 @@ module Aws::Pinpoint
     #       addresses: {
     #         "__string" => {
     #           body_override: "__string",
-    #           channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU
+    #           channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
     #           context: {
     #             "__string" => "__string",
     #           },
@@ -3808,10 +4031,10 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Update an APNS VOIP channel
+    # Update an APNS VoIP channel
     #
     # @option params [required, Types::APNSVoipChannelRequest] :apns_voip_channel_request
-    #   Apple VOIP Push Notification Service channel definition.
+    #   Apple VoIP Push Notification Service channel definition.
     #
     # @option params [required, String] :application_id
     #
@@ -3859,10 +4082,10 @@ module Aws::Pinpoint
       req.send_request(options)
     end
 
-    # Update an APNS VOIP sandbox channel
+    # Update an APNS VoIP sandbox channel
     #
     # @option params [required, Types::APNSVoipSandboxChannelRequest] :apns_voip_sandbox_channel_request
-    #   Apple VOIP Developer Push Notification Service channel definition.
+    #   Apple VoIP Developer Push Notification Service channel definition.
     #
     # @option params [required, String] :application_id
     #
@@ -3926,6 +4149,11 @@ module Aws::Pinpoint
     #   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",
+    #       },
     #       limits: {
     #         daily: 1,
     #         maximum_duration: 1,
@@ -3942,6 +4170,9 @@ module Aws::Pinpoint
     # @example 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
@@ -4121,6 +4352,11 @@ module Aws::Pinpoint
     #       ],
     #       description: "__string",
     #       holdout_percent: 1,
+    #       hook: {
+    #         lambda_function_name: "__string",
+    #         mode: "DELIVERY", # accepts DELIVERY, FILTER
+    #         web_url: "__string",
+    #       },
     #       is_paused: false,
     #       limits: {
     #         daily: 1,
@@ -4307,6 +4543,9 @@ module Aws::Pinpoint
     #   resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
     #   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
@@ -4471,7 +4710,7 @@ module Aws::Pinpoint
     #       attributes: {
     #         "__string" => ["__string"],
     #       },
-    #       channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU
+    #       channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
     #       demographic: {
     #         app_version: "__string",
     #         locale: "__string",
@@ -4542,7 +4781,7 @@ module Aws::Pinpoint
     #           attributes: {
     #             "__string" => ["__string"],
     #           },
-    #           channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU
+    #           channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
     #           demographic: {
     #             app_version: "__string",
     #             locale: "__string",
@@ -4829,7 +5068,7 @@ module Aws::Pinpoint
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-pinpoint'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end