aws-sdk-partnercentralmarketing 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-partnercentralmarketing/client.rb +2921 -0
- data/lib/aws-sdk-partnercentralmarketing/client_api.rb +1246 -0
- data/lib/aws-sdk-partnercentralmarketing/customizations.rb +0 -0
- data/lib/aws-sdk-partnercentralmarketing/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-partnercentralmarketing/endpoint_provider.rb +32 -0
- data/lib/aws-sdk-partnercentralmarketing/endpoints.rb +20 -0
- data/lib/aws-sdk-partnercentralmarketing/errors.rb +227 -0
- data/lib/aws-sdk-partnercentralmarketing/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-partnercentralmarketing/resource.rb +26 -0
- data/lib/aws-sdk-partnercentralmarketing/types.rb +3777 -0
- data/lib/aws-sdk-partnercentralmarketing.rb +61 -0
- data/sig/client.rbs +476 -0
- data/sig/errors.rbs +50 -0
- data/sig/resource.rbs +86 -0
- data/sig/types.rbs +759 -0
- metadata +95 -0
|
@@ -0,0 +1,2921 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rpc_v2'
|
|
38
|
+
|
|
39
|
+
module Aws::PartnerCentralMarketing
|
|
40
|
+
# An API client for PartnerCentralMarketing. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
41
|
+
#
|
|
42
|
+
# client = Aws::PartnerCentralMarketing::Client.new(
|
|
43
|
+
# region: region_name,
|
|
44
|
+
# credentials: credentials,
|
|
45
|
+
# # ...
|
|
46
|
+
# )
|
|
47
|
+
#
|
|
48
|
+
# For details on configuring region and credentials see
|
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
|
50
|
+
#
|
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
|
52
|
+
class Client < Seahorse::Client::Base
|
|
53
|
+
|
|
54
|
+
include Aws::ClientStubs
|
|
55
|
+
|
|
56
|
+
@identifier = :partnercentralmarketing
|
|
57
|
+
|
|
58
|
+
set_api(ClientApi::API)
|
|
59
|
+
|
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
|
76
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
78
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
79
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
|
80
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
86
|
+
add_plugin(Aws::Plugins::Sign)
|
|
87
|
+
add_plugin(Aws::Plugins::Protocols::RpcV2)
|
|
88
|
+
add_plugin(Aws::PartnerCentralMarketing::Plugins::Endpoints)
|
|
89
|
+
|
|
90
|
+
# @overload initialize(options)
|
|
91
|
+
# @param [Hash] options
|
|
92
|
+
#
|
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
|
95
|
+
# class name or an instance of a plugin class.
|
|
96
|
+
#
|
|
97
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
100
|
+
#
|
|
101
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
102
|
+
# credentials.
|
|
103
|
+
#
|
|
104
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
|
105
|
+
# shared file, such as `~/.aws/config`.
|
|
106
|
+
#
|
|
107
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
108
|
+
#
|
|
109
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
|
110
|
+
# assume a role after providing credentials via the web.
|
|
111
|
+
#
|
|
112
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
|
113
|
+
# access token generated from `aws login`.
|
|
114
|
+
#
|
|
115
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
|
116
|
+
# process that outputs to stdout.
|
|
117
|
+
#
|
|
118
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
119
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
120
|
+
#
|
|
121
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
|
122
|
+
# instances running in ECS.
|
|
123
|
+
#
|
|
124
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
125
|
+
# from the Cognito Identity service.
|
|
126
|
+
#
|
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
128
|
+
#
|
|
129
|
+
# * `Aws.config[:credentials]`
|
|
130
|
+
#
|
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
|
+
# `:account_id` options.
|
|
133
|
+
#
|
|
134
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
135
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
136
|
+
#
|
|
137
|
+
# * `~/.aws/credentials`
|
|
138
|
+
#
|
|
139
|
+
# * `~/.aws/config`
|
|
140
|
+
#
|
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
145
|
+
#
|
|
146
|
+
# @option options [required, String] :region
|
|
147
|
+
# The AWS region to connect to. The configured `:region` is
|
|
148
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
149
|
+
# a default `:region` is searched for in the following locations:
|
|
150
|
+
#
|
|
151
|
+
# * `Aws.config[:region]`
|
|
152
|
+
# * `ENV['AWS_REGION']`
|
|
153
|
+
# * `ENV['AMAZON_REGION']`
|
|
154
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
155
|
+
# * `~/.aws/credentials`
|
|
156
|
+
# * `~/.aws/config`
|
|
157
|
+
#
|
|
158
|
+
# @option options [String] :access_key_id
|
|
159
|
+
#
|
|
160
|
+
# @option options [String] :account_id
|
|
161
|
+
#
|
|
162
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
|
163
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
|
164
|
+
# the background every 60 secs (default). Defaults to `false`.
|
|
165
|
+
#
|
|
166
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
167
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
168
|
+
# until there is sufficent client side capacity to retry the request.
|
|
169
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
170
|
+
# not retry instead of sleeping.
|
|
171
|
+
#
|
|
172
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
173
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
174
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
175
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
176
|
+
#
|
|
177
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
|
178
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
|
179
|
+
# this client.
|
|
180
|
+
#
|
|
181
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
|
182
|
+
# Allows you to provide an identifier for this client which will be attached to
|
|
183
|
+
# all generated client side metrics. Defaults to an empty string.
|
|
184
|
+
#
|
|
185
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
|
186
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
|
187
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
|
188
|
+
#
|
|
189
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
|
190
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
|
191
|
+
# agent is running on, where client metrics will be published via UDP.
|
|
192
|
+
#
|
|
193
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
|
194
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
|
195
|
+
# will use the Client Side Monitoring Agent Publisher.
|
|
196
|
+
#
|
|
197
|
+
# @option options [Boolean] :convert_params (true)
|
|
198
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
199
|
+
# the required types.
|
|
200
|
+
#
|
|
201
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether
|
|
203
|
+
# to apply a clock skew correction and retry requests with skewed client
|
|
204
|
+
# clocks. Takes effect only when `disable_clock_skew_correction` is not set.
|
|
205
|
+
#
|
|
206
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
207
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
208
|
+
# accepted modes and the configuration defaults that are included.
|
|
209
|
+
#
|
|
210
|
+
# @option options [Boolean] :disable_clock_skew_correction
|
|
211
|
+
# Used only in `standard` and `adaptive` retry modes. When `true`, the
|
|
212
|
+
# SDK does not apply a clock skew correction, does not update its stored
|
|
213
|
+
# skew from responses, and does not retry clock skew errors. Clock skew
|
|
214
|
+
# correction is enabled by default.
|
|
215
|
+
#
|
|
216
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
217
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
218
|
+
#
|
|
219
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
220
|
+
# When set to 'true' the request body will not be compressed
|
|
221
|
+
# for supported operations.
|
|
222
|
+
#
|
|
223
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
224
|
+
# Normally you should not configure the `:endpoint` option
|
|
225
|
+
# directly. This is normally constructed from the `:region`
|
|
226
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
227
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
228
|
+
# be a URI formatted like:
|
|
229
|
+
#
|
|
230
|
+
# 'http://example.com'
|
|
231
|
+
# 'https://example.com'
|
|
232
|
+
# 'http://example.com:123'
|
|
233
|
+
#
|
|
234
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
235
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
236
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
|
237
|
+
#
|
|
238
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
|
239
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
|
240
|
+
#
|
|
241
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
|
242
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
|
243
|
+
# Use this option to config the time interval in seconds for making
|
|
244
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
|
245
|
+
#
|
|
246
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
|
247
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
248
|
+
#
|
|
249
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
250
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
251
|
+
# variables and the shared configuration file.
|
|
252
|
+
#
|
|
253
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
254
|
+
# The log formatter.
|
|
255
|
+
#
|
|
256
|
+
# @option options [Symbol] :log_level (:info)
|
|
257
|
+
# The log level to send messages to the `:logger` at.
|
|
258
|
+
#
|
|
259
|
+
# @option options [Logger] :logger
|
|
260
|
+
# The Logger instance to send log messages to. If this option
|
|
261
|
+
# is not set, logging will be disabled.
|
|
262
|
+
#
|
|
263
|
+
# @option options [Integer] :max_attempts (3)
|
|
264
|
+
# An integer representing the maximum number attempts that will be made for
|
|
265
|
+
# a single request, including the initial attempt. For example,
|
|
266
|
+
# setting this value to 5 will result in a request being retried up to
|
|
267
|
+
# 4 times. Used in `standard` and `adaptive` retry modes. Defaults to 3,
|
|
268
|
+
# except for DynamoDB and DynamoDB Streams, which default to 4.
|
|
269
|
+
#
|
|
270
|
+
# @option options [String] :profile ("default")
|
|
271
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
272
|
+
# When not specified, 'default' is used.
|
|
273
|
+
#
|
|
274
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
275
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
276
|
+
#
|
|
277
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
278
|
+
# calculated for all request payloads of operations modeled with the
|
|
279
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
280
|
+
# `requestAlgorithmMember` is modeled.
|
|
281
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
282
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
283
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
284
|
+
# is modeled and supplied.
|
|
285
|
+
#
|
|
286
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
287
|
+
# The minimum size in bytes that triggers compression for request
|
|
288
|
+
# bodies. The value must be non-negative integer value between 0
|
|
289
|
+
# and 10485780 bytes inclusive.
|
|
290
|
+
#
|
|
291
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
292
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
293
|
+
#
|
|
294
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
295
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
296
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
297
|
+
# are supported.
|
|
298
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
299
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
300
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
301
|
+
#
|
|
302
|
+
# @option options [Proc] :retry_backoff
|
|
303
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
304
|
+
# This option is only used in the `legacy` retry mode.
|
|
305
|
+
#
|
|
306
|
+
# @option options [Float] :retry_base_delay (0.3)
|
|
307
|
+
# The base delay in seconds used by the default backoff function. This option
|
|
308
|
+
# is only used in the `legacy` retry mode.
|
|
309
|
+
#
|
|
310
|
+
# @option options [Symbol] :retry_jitter (:none)
|
|
311
|
+
# A delay randomiser function used by the default backoff function.
|
|
312
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
|
313
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
|
314
|
+
# in the `legacy` retry mode.
|
|
315
|
+
#
|
|
316
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
317
|
+
#
|
|
318
|
+
# @option options [Integer] :retry_limit (3)
|
|
319
|
+
# The maximum number of times to retry failed requests. Only
|
|
320
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
321
|
+
# are retried. Generally, these are throttling errors, data
|
|
322
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
|
323
|
+
# endpoint discovery, and errors from expired credentials.
|
|
324
|
+
# This option is only used in the `legacy` retry mode.
|
|
325
|
+
#
|
|
326
|
+
# @option options [Integer] :retry_max_delay (0)
|
|
327
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
328
|
+
# used by the default backoff function. This option is only used in the
|
|
329
|
+
# `legacy` retry mode.
|
|
330
|
+
#
|
|
331
|
+
# @option options [String] :retry_mode ("standard")
|
|
332
|
+
# Specifies which retry algorithm to use. Values are:
|
|
333
|
+
#
|
|
334
|
+
# * `legacy` - The pre-existing retry behavior.
|
|
335
|
+
#
|
|
336
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
337
|
+
# This includes support for retry quotas, which limit the number of
|
|
338
|
+
# unsuccessful retries a client can make. This is the default value
|
|
339
|
+
# if no retry mode is provided.
|
|
340
|
+
#
|
|
341
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
342
|
+
# `standard` mode along with automatic client side throttling.
|
|
343
|
+
#
|
|
344
|
+
# @option options [String] :sdk_ua_app_id
|
|
345
|
+
# A unique and opaque application ID that is appended to the
|
|
346
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
347
|
+
# maximum length of 50. This variable is sourced from environment
|
|
348
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
349
|
+
#
|
|
350
|
+
# @option options [String] :secret_access_key
|
|
351
|
+
#
|
|
352
|
+
# @option options [String] :session_token
|
|
353
|
+
#
|
|
354
|
+
# @option options [Array] :sigv4a_signing_region_set
|
|
355
|
+
# A list of regions that should be signed with SigV4a signing. When
|
|
356
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
|
357
|
+
# in the following locations:
|
|
358
|
+
#
|
|
359
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
|
360
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
|
361
|
+
# * `~/.aws/config`
|
|
362
|
+
#
|
|
363
|
+
# @option options [Boolean] :stub_responses (false)
|
|
364
|
+
# Causes the client to return stubbed responses. By default
|
|
365
|
+
# fake responses are generated and returned. You can specify
|
|
366
|
+
# the response data to return or errors to raise by calling
|
|
367
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
368
|
+
#
|
|
369
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
370
|
+
# requests are made, and retries are disabled.
|
|
371
|
+
#
|
|
372
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
373
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
374
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
375
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
376
|
+
# following telemetry providers:
|
|
377
|
+
#
|
|
378
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
379
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
380
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
381
|
+
#
|
|
382
|
+
# @option options [Aws::TokenProvider] :token_provider
|
|
383
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
384
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
385
|
+
#
|
|
386
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
387
|
+
# tokens.
|
|
388
|
+
#
|
|
389
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
|
390
|
+
# access token generated from `aws login`.
|
|
391
|
+
#
|
|
392
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
|
393
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
|
394
|
+
#
|
|
395
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
396
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
397
|
+
# will be used if available.
|
|
398
|
+
#
|
|
399
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
400
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
401
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
402
|
+
# is set to `true`.
|
|
403
|
+
#
|
|
404
|
+
# @option options [Boolean] :validate_params (true)
|
|
405
|
+
# When `true`, request parameters are validated before
|
|
406
|
+
# sending the request.
|
|
407
|
+
#
|
|
408
|
+
# @option options [Aws::PartnerCentralMarketing::EndpointProvider] :endpoint_provider
|
|
409
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
410
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
|
411
|
+
# `Aws::PartnerCentralMarketing::EndpointParameters`.
|
|
412
|
+
#
|
|
413
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
414
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
415
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
416
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
417
|
+
# behaviour. This value can safely be set per request on the session.
|
|
418
|
+
#
|
|
419
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
420
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
421
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
422
|
+
# pool before making a request.
|
|
423
|
+
#
|
|
424
|
+
# @option options [Float] :http_open_timeout (15)
|
|
425
|
+
# The default number of seconds to wait for response data.
|
|
426
|
+
# This value can safely be set per-request on the session.
|
|
427
|
+
#
|
|
428
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
429
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
430
|
+
#
|
|
431
|
+
# @option options [Float] :http_read_timeout (60)
|
|
432
|
+
# The default number of seconds to wait for response data.
|
|
433
|
+
# This value can safely be set per-request on the session.
|
|
434
|
+
#
|
|
435
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
436
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
437
|
+
#
|
|
438
|
+
# @option options [Proc] :on_chunk_received
|
|
439
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
440
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
441
|
+
# the number of bytes received, and the total number of
|
|
442
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
443
|
+
#
|
|
444
|
+
# @option options [Proc] :on_chunk_sent
|
|
445
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
446
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
447
|
+
# the number of bytes read from the body, and the total number of
|
|
448
|
+
# bytes in the body.
|
|
449
|
+
#
|
|
450
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
451
|
+
# When `true`, response errors are raised.
|
|
452
|
+
#
|
|
453
|
+
# @option options [String] :ssl_ca_bundle
|
|
454
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
455
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
456
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
457
|
+
#
|
|
458
|
+
# @option options [String] :ssl_ca_directory
|
|
459
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
460
|
+
# authority files for verifying peer certificates. If you do
|
|
461
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
462
|
+
# default will be used if available.
|
|
463
|
+
#
|
|
464
|
+
# @option options [String] :ssl_ca_store
|
|
465
|
+
# Sets the X509::Store to verify peer certificate.
|
|
466
|
+
#
|
|
467
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
468
|
+
# Sets a client certificate when creating http connections.
|
|
469
|
+
#
|
|
470
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
471
|
+
# Sets a client key when creating http connections.
|
|
472
|
+
#
|
|
473
|
+
# @option options [Float] :ssl_timeout
|
|
474
|
+
# Sets the SSL timeout in seconds
|
|
475
|
+
#
|
|
476
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
477
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
478
|
+
#
|
|
479
|
+
def initialize(*args)
|
|
480
|
+
super
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
# @!group API Operations
|
|
484
|
+
|
|
485
|
+
# Instantiates one or more of the campaign template's blueprints as
|
|
486
|
+
# assets of this campaign.
|
|
487
|
+
#
|
|
488
|
+
# The only asset-create operation: DG-038 deleted the singular
|
|
489
|
+
# CreateCampaignAsset, and AWS Batch Operations makes exposing a
|
|
490
|
+
# singular alongside a batch optional ("which MAY actually be exposed in
|
|
491
|
+
# addition"). It also replaced kit instantiation -- CreateCampaign
|
|
492
|
+
# creates zero assets, so this is the only path by which an asset comes
|
|
493
|
+
# into existence.
|
|
494
|
+
#
|
|
495
|
+
# Errors here are whole-request only, and nothing is written when one is
|
|
496
|
+
# thrown. Per-entry failures ride in the response's `Errors` list with
|
|
497
|
+
# a 200. ServiceQuotaExceededException is deliberately absent: a
|
|
498
|
+
# campaign holds at most one asset per blueprint (I-15), so the ceiling
|
|
499
|
+
# is the size of the bound kit and a request of unique valid entries
|
|
500
|
+
# cannot exceed it.
|
|
501
|
+
#
|
|
502
|
+
# @option params [required, String] :catalog
|
|
503
|
+
# The catalog (AWS or Sandbox).
|
|
504
|
+
#
|
|
505
|
+
# @option params [required, String] :campaign_identifier
|
|
506
|
+
# The campaign identifier.
|
|
507
|
+
#
|
|
508
|
+
# @option params [required, Array<Types::BatchCreateCampaignAssetEntry>] :entries
|
|
509
|
+
# The blueprints to instantiate, one entry each.
|
|
510
|
+
#
|
|
511
|
+
# @return [Types::BatchCreateCampaignAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
512
|
+
#
|
|
513
|
+
# * {Types::BatchCreateCampaignAssetResponse#errors #errors} => Array<Types::BatchCreateCampaignAssetError>
|
|
514
|
+
# * {Types::BatchCreateCampaignAssetResponse#successful #successful} => Array<Types::BatchCreateCampaignAssetResult>
|
|
515
|
+
#
|
|
516
|
+
#
|
|
517
|
+
# @example Example: Instantiate two of the kit's blueprints
|
|
518
|
+
#
|
|
519
|
+
# resp = client.batch_create_campaign_asset({
|
|
520
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
521
|
+
# catalog: "AWS",
|
|
522
|
+
# entries: [
|
|
523
|
+
# {
|
|
524
|
+
# source_asset_template_identifier: "ta000000email",
|
|
525
|
+
# },
|
|
526
|
+
# {
|
|
527
|
+
# source_asset_template_identifier: "ta0000000lp01",
|
|
528
|
+
# },
|
|
529
|
+
# ],
|
|
530
|
+
# })
|
|
531
|
+
#
|
|
532
|
+
# resp.to_h outputs the following:
|
|
533
|
+
# {
|
|
534
|
+
# errors: [
|
|
535
|
+
# ],
|
|
536
|
+
# successful: [
|
|
537
|
+
# {
|
|
538
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
539
|
+
# source_asset_template_id: "ta000000email",
|
|
540
|
+
# },
|
|
541
|
+
# {
|
|
542
|
+
# id: "ast-9f3c1a2b7d40e",
|
|
543
|
+
# source_asset_template_id: "ta0000000lp01",
|
|
544
|
+
# },
|
|
545
|
+
# ],
|
|
546
|
+
# }
|
|
547
|
+
#
|
|
548
|
+
# @example Example: A partial batch: one entry names a blueprint the campaign's template does not carry
|
|
549
|
+
#
|
|
550
|
+
# resp = client.batch_create_campaign_asset({
|
|
551
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
552
|
+
# catalog: "AWS",
|
|
553
|
+
# entries: [
|
|
554
|
+
# {
|
|
555
|
+
# source_asset_template_identifier: "ta000000email",
|
|
556
|
+
# },
|
|
557
|
+
# {
|
|
558
|
+
# source_asset_template_identifier: "ta00000absent",
|
|
559
|
+
# },
|
|
560
|
+
# ],
|
|
561
|
+
# })
|
|
562
|
+
#
|
|
563
|
+
# resp.to_h outputs the following:
|
|
564
|
+
# {
|
|
565
|
+
# errors: [
|
|
566
|
+
# {
|
|
567
|
+
# code: "ResourceNotFoundException",
|
|
568
|
+
# message: "No asset template ta00000absent on this campaign's template.",
|
|
569
|
+
# source_asset_template_id: "ta00000absent",
|
|
570
|
+
# },
|
|
571
|
+
# ],
|
|
572
|
+
# successful: [
|
|
573
|
+
# {
|
|
574
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
575
|
+
# source_asset_template_id: "ta000000email",
|
|
576
|
+
# },
|
|
577
|
+
# ],
|
|
578
|
+
# }
|
|
579
|
+
#
|
|
580
|
+
# @example Request syntax with placeholder values
|
|
581
|
+
#
|
|
582
|
+
# resp = client.batch_create_campaign_asset({
|
|
583
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
584
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
585
|
+
# entries: [ # required
|
|
586
|
+
# {
|
|
587
|
+
# source_asset_template_identifier: "Identifier", # required
|
|
588
|
+
# },
|
|
589
|
+
# ],
|
|
590
|
+
# })
|
|
591
|
+
#
|
|
592
|
+
# @example Response structure
|
|
593
|
+
#
|
|
594
|
+
# resp.errors #=> Array
|
|
595
|
+
# resp.errors[0].source_asset_template_id #=> String
|
|
596
|
+
# resp.errors[0].code #=> String
|
|
597
|
+
# resp.errors[0].message #=> String
|
|
598
|
+
# resp.successful #=> Array
|
|
599
|
+
# resp.successful[0].source_asset_template_id #=> String
|
|
600
|
+
# resp.successful[0].id #=> String
|
|
601
|
+
# resp.successful[0].layout.selected #=> String
|
|
602
|
+
# resp.successful[0].layout.options #=> Array
|
|
603
|
+
# resp.successful[0].layout.options[0].value #=> String
|
|
604
|
+
# resp.successful[0].layout.options[0].label #=> String
|
|
605
|
+
# resp.successful[0].layout.options[0].field_ids #=> Array
|
|
606
|
+
# resp.successful[0].layout.options[0].field_ids[0] #=> String
|
|
607
|
+
# resp.successful[0].layout.options[0].layout_previews #=> Array
|
|
608
|
+
# resp.successful[0].layout.options[0].layout_previews[0].format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
609
|
+
# resp.successful[0].layout.options[0].layout_previews[0].url #=> String
|
|
610
|
+
# resp.successful[0].layout.options[0].layout_previews[0].page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
611
|
+
#
|
|
612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAsset AWS API Documentation
|
|
613
|
+
#
|
|
614
|
+
# @overload batch_create_campaign_asset(params = {})
|
|
615
|
+
# @param [Hash] params ({})
|
|
616
|
+
def batch_create_campaign_asset(params = {}, options = {})
|
|
617
|
+
req = build_request(:batch_create_campaign_asset, params)
|
|
618
|
+
req.send_request(options)
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# Creates a new marketing campaign.
|
|
622
|
+
#
|
|
623
|
+
# Returns the identity of the new campaign, not the campaign. Growing a
|
|
624
|
+
# response is backward compatible and shrinking one is not, and the
|
|
625
|
+
# caller's next step is a `GetCampaign` anyway — a write that supplies
|
|
626
|
+
# an audience cannot report its scan verdict, because that is decided
|
|
627
|
+
# after it commits.
|
|
628
|
+
#
|
|
629
|
+
# @option params [required, String] :catalog
|
|
630
|
+
# The catalog (AWS or Sandbox).
|
|
631
|
+
#
|
|
632
|
+
# @option params [required, String] :name
|
|
633
|
+
# The display name.
|
|
634
|
+
#
|
|
635
|
+
# @option params [required, String] :campaign_template_id
|
|
636
|
+
# The campaign template this campaign draws its assets from.
|
|
637
|
+
#
|
|
638
|
+
# Binds the campaign to a single source template: every asset must come
|
|
639
|
+
# from this template's asset templates, and one from another template
|
|
640
|
+
# is refused at `BatchCreateCampaignAsset`. Immutable once set. Every
|
|
641
|
+
# campaign has one: a campaign's language and its assets' blueprints
|
|
642
|
+
# both come from its template. Templates are AWS-authored and read-only
|
|
643
|
+
# — they are discovered through
|
|
644
|
+
# `SearchCampaignTemplates` and `GetCampaignTemplate`, and there is
|
|
645
|
+
# no create, update or delete operation for one. The template's id
|
|
646
|
+
# only: a campaign template has no ARN (DG-084). The
|
|
647
|
+
# member keeps the `<Resource>Id` name, which is the convention for
|
|
648
|
+
# referencing another resource from a body. </Resource>
|
|
649
|
+
#
|
|
650
|
+
# @option params [String] :sender_email
|
|
651
|
+
# The address every email of this campaign is sent from.
|
|
652
|
+
#
|
|
653
|
+
# Printable ASCII only, with no spaces or line breaks, or field code
|
|
654
|
+
# `PATTERN\_MISMATCH`. Then three rules, all checked when the sender
|
|
655
|
+
# is set. Its domain must exactly match, ignoring case, the domain of
|
|
656
|
+
# the partner's alliance lead email in AWS Partner Central (a subdomain
|
|
657
|
+
# does not), or field code `SENDER\_DOMAIN\_NOT\_ALLIANCE\_LEAD`.
|
|
658
|
+
# Then, for a sender at example.com, DNS must hold the CNAME
|
|
659
|
+
# `dkim.\_domainkey.example.com` → `dkim.\_domainkey.md02.com`
|
|
660
|
+
# (field code `SENDER\_DOMAIN\_DKIM\_MISSING`) and a DMARC record, one
|
|
661
|
+
# TXT `\_dmarc.example.com` starting `v=DMARC1` with a `p` of
|
|
662
|
+
# `none`, `quarantine` or `reject` (field code
|
|
663
|
+
# `SENDER\_DOMAIN\_DMARC\_MISSING`). Both DNS codes are reported
|
|
664
|
+
# together when both records are missing. A partner who can't satisfy
|
|
665
|
+
# them can't set a sender, so can't run
|
|
666
|
+
# email campaigns. A shared mail provider's domain, such as gmail.com,
|
|
667
|
+
# can't carry the records. Optional here: a campaign with no sender can
|
|
668
|
+
# be created and edited, but its email assets cannot be activated until
|
|
669
|
+
# one is set.
|
|
670
|
+
#
|
|
671
|
+
# @option params [String] :privacy_policy_url
|
|
672
|
+
# The URL of the partner's privacy policy, linked from every email and
|
|
673
|
+
# landing page footer. Optional here: a campaign whose emails or landing
|
|
674
|
+
# pages show it cannot activate them until one is set.
|
|
675
|
+
#
|
|
676
|
+
# @option params [String] :partner_address
|
|
677
|
+
# The partner's physical postal address, shown in every email footer
|
|
678
|
+
# and as a landing page's contact line. Optional here: an email that
|
|
679
|
+
# shows it cannot activate until one is set. A landing page that shows
|
|
680
|
+
# it publishes it empty when it is unset, and a document's footer then
|
|
681
|
+
# prints the partner's name alone.
|
|
682
|
+
#
|
|
683
|
+
# @option params [Types::FileRef] :partner_badge
|
|
684
|
+
# The partner's badge — a tier or designation badge from AWS Partner
|
|
685
|
+
# Badge Manager — shown in every badge slot of the campaign's emails,
|
|
686
|
+
# landing pages and documents. Optional: until one is set, every badge
|
|
687
|
+
# slot shows the Standalone AWS Partner badge.
|
|
688
|
+
#
|
|
689
|
+
# A PNG or JPEG of at most 2 MB, staged like an asset image and checked
|
|
690
|
+
# the same way: it must have passed the staging scan
|
|
691
|
+
# (`SCAN\_REJECTED`, or `SCAN\_IN\_PROGRESS` while it is pending),
|
|
692
|
+
# and its bytes must be the format its name says
|
|
693
|
+
# (`IMAGE\_FORMAT\_NOT\_SUPPORTED`). Any shape is accepted: a badge is
|
|
694
|
+
# drawn whole, never cropped. Content moderation judges it when an asset
|
|
695
|
+
# that shows it is activated.
|
|
696
|
+
#
|
|
697
|
+
# @option params [Types::FileRef] :email_target
|
|
698
|
+
# The campaign's send audience — a CSV of recipient email addresses.
|
|
699
|
+
#
|
|
700
|
+
# The campaign's *target*: who the campaign is sent to, as distinct
|
|
701
|
+
# from a `CampaignAsset`, which is the content that is sent. It sits
|
|
702
|
+
# on the campaign and not on the activation call because a partner
|
|
703
|
+
# assembles it in the same wizard flow that sets the name and the dates
|
|
704
|
+
# — and because attaching it here means it is validated, staged and
|
|
705
|
+
# resolved to a count before anything is activated, rather than at the
|
|
706
|
+
# last click. Required format: a header row naming the email column
|
|
707
|
+
# `Email`,
|
|
708
|
+
# `E-mail`, `Email Address` or `E-mail Address` — compared without
|
|
709
|
+
# case, spaces or punctuation. Other columns are permitted and ignored,
|
|
710
|
+
# and with two email columns the first is used. A file without such a
|
|
711
|
+
# header is refused with field code `EMAIL\_COLUMN\_MISSING`: the
|
|
712
|
+
# address column is never guessed. The rows reach the delivery
|
|
713
|
+
# platform's importer as the partner wrote them — a partner's audience
|
|
714
|
+
# is never rewritten. At most 5 MB, checked against the object's size
|
|
715
|
+
# before anything is
|
|
716
|
+
# copied, and at most 10,000 distinct addresses, refused with
|
|
717
|
+
# `RECIPIENT\_LIST\_TOO\_LARGE`. A file with no valid address at all
|
|
718
|
+
# is refused with `RECIPIENT\_LIST\_EMPTY`; otherwise rows without a
|
|
719
|
+
# usable address are not a refusal: they are skipped and counted, and
|
|
720
|
+
# `GetCampaign` reports the counts. Optional here, because a campaign
|
|
721
|
+
# is a container and holds no state to be incomplete in — but an email
|
|
722
|
+
# asset cannot be activated without it, so the requirement moved to the
|
|
723
|
+
# point of activation. Editable at any time, and an edit reaches the
|
|
724
|
+
# delivery platform only
|
|
725
|
+
# when an asset is activated after it. Each email activation loads the
|
|
726
|
+
# audience into a contact list of its own, so an address taken off the
|
|
727
|
+
# file is not sent to by the next activation. The bytes are write-only.
|
|
728
|
+
# No response returns a URL or an `S3Uri`
|
|
729
|
+
# for this file; `GetCampaign` returns the scan verdict, when the list
|
|
730
|
+
# was attached and how its rows resolved, and nothing more.
|
|
731
|
+
#
|
|
732
|
+
# @option params [Array<String>] :email_target_engagement_group_ids
|
|
733
|
+
# Engagement groups whose contacts the campaign's emails will also go
|
|
734
|
+
# to: the `Id`s `ListEngagementGroups` returns (AWS Partner Central
|
|
735
|
+
# Selling). 1–10, each named once.
|
|
736
|
+
#
|
|
737
|
+
# Each group is named once: a repeated id is refused with field code
|
|
738
|
+
# `INVALID\_VALUE`. Not checked against your groups when saved.
|
|
739
|
+
# StartCampaignAssetActivationTask resolves them to recipients. On a
|
|
740
|
+
# stage that can't resolve groups yet, Start refuses an email while
|
|
741
|
+
# groups are set (`ENGAGEMENT\_GROUPS\_UNAVAILABLE`), rather than send
|
|
742
|
+
# to `EmailTarget` alone.
|
|
743
|
+
#
|
|
744
|
+
# @option params [Types::TargetAudience] :target_audience
|
|
745
|
+
# Advisory targeting metadata. Refined later, and not validated here.
|
|
746
|
+
#
|
|
747
|
+
# @option params [Types::MonetaryValue] :estimated_budget
|
|
748
|
+
# What the partner expects the campaign to cost.
|
|
749
|
+
#
|
|
750
|
+
# @option params [Types::MonetaryValue] :total_budget
|
|
751
|
+
# The campaign's total budget.
|
|
752
|
+
#
|
|
753
|
+
# @option params [String] :start_on
|
|
754
|
+
# The first day of the campaign's run window. Not after `EndOn`
|
|
755
|
+
# (`ValidationException`, `INVALID_VALUE`).
|
|
756
|
+
#
|
|
757
|
+
# @option params [String] :end_on
|
|
758
|
+
# The last day of the campaign's run window, inclusive and in UTC. Not
|
|
759
|
+
# in the past: the campaign completes at the UTC midnight after it (see
|
|
760
|
+
# `CampaignState`). A scheduled send must fall on or before it.
|
|
761
|
+
#
|
|
762
|
+
# Optional here, but required before any asset activates: until it is
|
|
763
|
+
# set, GetCampaign's `ActivationIssues` reports `END_ON_MISSING` and
|
|
764
|
+
# StartCampaignAssetActivationTask refuses (`CAMPAIGN_INCOMPLETE`). Set
|
|
765
|
+
# it with UpdateCampaign.
|
|
766
|
+
#
|
|
767
|
+
# @option params [String] :client_token
|
|
768
|
+
# Idempotency token. Same token within 24h returns existing resource.
|
|
769
|
+
#
|
|
770
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
771
|
+
# not need to pass this option.**
|
|
772
|
+
#
|
|
773
|
+
# @option params [Array<Types::Tag>] :tags
|
|
774
|
+
# Tags to apply at creation.
|
|
775
|
+
#
|
|
776
|
+
# Tag-on-create rather than create-then-tag is a Tagris requirement, not
|
|
777
|
+
# a convenience: it is what lets a tag-based access control policy
|
|
778
|
+
# govern the creation itself. A campaign created untagged and tagged a
|
|
779
|
+
# moment later is briefly outside any such policy.
|
|
780
|
+
#
|
|
781
|
+
# A key beginning `aws:` (any case) is reserved for AWS-applied system
|
|
782
|
+
# tags and is refused with `ValidationException`, as is a key repeated
|
|
783
|
+
# in the list; nothing is created. The tags are recorded before the
|
|
784
|
+
# campaign is written, so a create that cannot record them fails and
|
|
785
|
+
# creates nothing. A retry with the same `ClientToken` returns the
|
|
786
|
+
# campaign the first attempt created and does not re-apply tags — use
|
|
787
|
+
# `TagResource` to change them afterwards. `ListTagsForResource`
|
|
788
|
+
# returns them.
|
|
789
|
+
#
|
|
790
|
+
# @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
791
|
+
#
|
|
792
|
+
# * {Types::CreateCampaignResponse#id #id} => String
|
|
793
|
+
# * {Types::CreateCampaignResponse#arn #arn} => String
|
|
794
|
+
#
|
|
795
|
+
#
|
|
796
|
+
# @example Example: Create a campaign
|
|
797
|
+
#
|
|
798
|
+
# resp = client.create_campaign({
|
|
799
|
+
# campaign_template_id: "tmpl-a1b2c3d4e5f6g",
|
|
800
|
+
# catalog: "AWS",
|
|
801
|
+
# end_on: "2026-12-31",
|
|
802
|
+
# name: "Q4 GenAI Campaign",
|
|
803
|
+
# start_on: "2026-11-01",
|
|
804
|
+
# total_budget: {
|
|
805
|
+
# amount: "25000.00",
|
|
806
|
+
# currency_code: "USD",
|
|
807
|
+
# },
|
|
808
|
+
# })
|
|
809
|
+
#
|
|
810
|
+
# resp.to_h outputs the following:
|
|
811
|
+
# {
|
|
812
|
+
# arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/campaign/camp-5Hq2m8x4k1p9w",
|
|
813
|
+
# id: "camp-5Hq2m8x4k1p9w",
|
|
814
|
+
# }
|
|
815
|
+
#
|
|
816
|
+
# @example Request syntax with placeholder values
|
|
817
|
+
#
|
|
818
|
+
# resp = client.create_campaign({
|
|
819
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
820
|
+
# name: "CampaignName", # required
|
|
821
|
+
# campaign_template_id: "CampaignTemplateId", # required
|
|
822
|
+
# sender_email: "SenderEmail",
|
|
823
|
+
# privacy_policy_url: "PrivacyPolicyUrl",
|
|
824
|
+
# partner_address: "PartnerAddress",
|
|
825
|
+
# partner_badge: {
|
|
826
|
+
# s3_uri: "S3Uri", # required
|
|
827
|
+
# version_id: "S3VersionId", # required
|
|
828
|
+
# },
|
|
829
|
+
# email_target: {
|
|
830
|
+
# s3_uri: "S3Uri", # required
|
|
831
|
+
# version_id: "S3VersionId", # required
|
|
832
|
+
# },
|
|
833
|
+
# email_target_engagement_group_ids: ["EngagementGroupId"],
|
|
834
|
+
# target_audience: {
|
|
835
|
+
# industries: ["FINANCIAL_SERVICES"], # accepts FINANCIAL_SERVICES, HEALTHCARE, MANUFACTURING, RETAIL, MEDIA_ENTERTAINMENT, ENERGY, EDUCATION, GOVERNMENT, TELECOMMUNICATIONS, AUTOMOTIVE, INSURANCE, OTHER
|
|
836
|
+
# company_sizes: ["STARTUP"], # accepts STARTUP, SMALL_BUSINESS, MID_MARKET, ENTERPRISE, GLOBAL_ENTERPRISE
|
|
837
|
+
# countries: ["CountryCode"],
|
|
838
|
+
# },
|
|
839
|
+
# estimated_budget: {
|
|
840
|
+
# amount: "Amount", # required
|
|
841
|
+
# currency_code: "CurrencyCode", # required
|
|
842
|
+
# },
|
|
843
|
+
# total_budget: {
|
|
844
|
+
# amount: "Amount", # required
|
|
845
|
+
# currency_code: "CurrencyCode", # required
|
|
846
|
+
# },
|
|
847
|
+
# start_on: "UtcDate",
|
|
848
|
+
# end_on: "UtcDate",
|
|
849
|
+
# client_token: "ClientToken",
|
|
850
|
+
# tags: [
|
|
851
|
+
# {
|
|
852
|
+
# key: "TagKey", # required
|
|
853
|
+
# value: "TagValue", # required
|
|
854
|
+
# },
|
|
855
|
+
# ],
|
|
856
|
+
# })
|
|
857
|
+
#
|
|
858
|
+
# @example Response structure
|
|
859
|
+
#
|
|
860
|
+
# resp.id #=> String
|
|
861
|
+
# resp.arn #=> String
|
|
862
|
+
#
|
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateCampaign AWS API Documentation
|
|
864
|
+
#
|
|
865
|
+
# @overload create_campaign(params = {})
|
|
866
|
+
# @param [Hash] params ({})
|
|
867
|
+
def create_campaign(params = {}, options = {})
|
|
868
|
+
req = build_request(:create_campaign, params)
|
|
869
|
+
req.send_request(options)
|
|
870
|
+
end
|
|
871
|
+
|
|
872
|
+
# Creates a single-use URL the partner visits to authorize publishing on
|
|
873
|
+
# a platform. Serves a first connect, connecting a further account, and
|
|
874
|
+
# re-authorizing an expired one: consenting with an account that is
|
|
875
|
+
# already connected re-authorizes that connection and keeps its id; any
|
|
876
|
+
# other account adds a connection. Poll ListSocialConnections for the
|
|
877
|
+
# outcome. Deliberately not idempotent and takes no client token: every
|
|
878
|
+
# call must mint a fresh single-use URL, so replaying a cached response
|
|
879
|
+
# would hand back a dead one.
|
|
880
|
+
#
|
|
881
|
+
# @option params [required, String] :catalog
|
|
882
|
+
# Catalog the connection belongs to.
|
|
883
|
+
#
|
|
884
|
+
# @option params [required, String] :platform
|
|
885
|
+
# Social platform to authorize.
|
|
886
|
+
#
|
|
887
|
+
# @return [Types::CreateSocialConnectionAuthorizationUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
888
|
+
#
|
|
889
|
+
# * {Types::CreateSocialConnectionAuthorizationUrlResponse#platform #platform} => String
|
|
890
|
+
# * {Types::CreateSocialConnectionAuthorizationUrlResponse#authorization_url #authorization_url} => String
|
|
891
|
+
#
|
|
892
|
+
# @example Request syntax with placeholder values
|
|
893
|
+
#
|
|
894
|
+
# resp = client.create_social_connection_authorization_url({
|
|
895
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
896
|
+
# platform: "FACEBOOK", # required, accepts FACEBOOK, LINKEDIN, X
|
|
897
|
+
# })
|
|
898
|
+
#
|
|
899
|
+
# @example Response structure
|
|
900
|
+
#
|
|
901
|
+
# resp.platform #=> String, one of "FACEBOOK", "LINKEDIN", "X"
|
|
902
|
+
# resp.authorization_url #=> String
|
|
903
|
+
#
|
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateSocialConnectionAuthorizationUrl AWS API Documentation
|
|
905
|
+
#
|
|
906
|
+
# @overload create_social_connection_authorization_url(params = {})
|
|
907
|
+
# @param [Hash] params ({})
|
|
908
|
+
def create_social_connection_authorization_url(params = {}, options = {})
|
|
909
|
+
req = build_request(:create_social_connection_authorization_url, params)
|
|
910
|
+
req.send_request(options)
|
|
911
|
+
end
|
|
912
|
+
|
|
913
|
+
# Stops a live campaign asset: an email's scheduled send is withdrawn,
|
|
914
|
+
# a social post is removed before it publishes. On a completed campaign,
|
|
915
|
+
# it also removes a published document, banner or landing page.
|
|
916
|
+
#
|
|
917
|
+
# Synchronous, and safe to repeat. Does not delete the asset record, so
|
|
918
|
+
# a stopped email or social post can be started again.
|
|
919
|
+
#
|
|
920
|
+
# Not every asset can be stopped, and the reasons differ in kind. An
|
|
921
|
+
# email that has begun sending **cannot** be recalled: the send is gone.
|
|
922
|
+
# A document, a banner or a landing page is **refused** with
|
|
923
|
+
# `ASSET_NOT_DEACTIVATABLE` until the campaign has completed (the UTC
|
|
924
|
+
# date is after its `EndOn`). Until then the partner fixes one in place
|
|
925
|
+
# by updating it and activating it again, which keeps its URL, so every
|
|
926
|
+
# email that already linked to it keeps working.
|
|
927
|
+
#
|
|
928
|
+
# Once the campaign has completed, the removal is permanent, because a
|
|
929
|
+
# completed campaign can't activate anything again:
|
|
930
|
+
#
|
|
931
|
+
# * A document's published PDF is deleted. Its URL stops serving within
|
|
932
|
+
# about a minute (the CDN revalidates), and `PublicUrl` is no longer
|
|
933
|
+
# returned. Anything that linked to it, such as a landing page's
|
|
934
|
+
# download button or a sent email, reaches an error page. The export
|
|
935
|
+
# still contains the document.
|
|
936
|
+
# * A banner's or landing page's published object is taken down at the
|
|
937
|
+
# delivery platform, and the images the partner put on it are deleted.
|
|
938
|
+
# A landing page stops capturing leads, and its `PublicUrl` is no
|
|
939
|
+
# longer returned. A partner site that embedded a banner shows nothing
|
|
940
|
+
# there. The platform's own CDN can keep serving a copy a visitor
|
|
941
|
+
# already cached, which collects nothing.
|
|
942
|
+
#
|
|
943
|
+
# A landing page and a document it links to can be removed in either
|
|
944
|
+
# order.
|
|
945
|
+
#
|
|
946
|
+
# @option params [required, String] :catalog
|
|
947
|
+
# The catalog (AWS or Sandbox).
|
|
948
|
+
#
|
|
949
|
+
# @option params [required, String] :campaign_identifier
|
|
950
|
+
# The campaign identifier.
|
|
951
|
+
#
|
|
952
|
+
# @option params [required, String] :campaign_asset_identifier
|
|
953
|
+
# The asset identifier.
|
|
954
|
+
#
|
|
955
|
+
# @return [Types::DeactivateCampaignAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
956
|
+
#
|
|
957
|
+
# * {Types::DeactivateCampaignAssetResponse#id #id} => String
|
|
958
|
+
# * {Types::DeactivateCampaignAssetResponse#state #state} => String
|
|
959
|
+
# * {Types::DeactivateCampaignAssetResponse#last_activation_status #last_activation_status} => String
|
|
960
|
+
# * {Types::DeactivateCampaignAssetResponse#state_reason #state_reason} => String
|
|
961
|
+
#
|
|
962
|
+
# @example Request syntax with placeholder values
|
|
963
|
+
#
|
|
964
|
+
# resp = client.deactivate_campaign_asset({
|
|
965
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
966
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
967
|
+
# campaign_asset_identifier: "CampaignAssetId", # required
|
|
968
|
+
# })
|
|
969
|
+
#
|
|
970
|
+
# @example Response structure
|
|
971
|
+
#
|
|
972
|
+
# resp.id #=> String
|
|
973
|
+
# resp.state #=> String, one of "INACTIVE", "ACTIVE"
|
|
974
|
+
# resp.last_activation_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
975
|
+
# resp.state_reason #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
976
|
+
#
|
|
977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeactivateCampaignAsset AWS API Documentation
|
|
978
|
+
#
|
|
979
|
+
# @overload deactivate_campaign_asset(params = {})
|
|
980
|
+
# @param [Hash] params ({})
|
|
981
|
+
def deactivate_campaign_asset(params = {}, options = {})
|
|
982
|
+
req = build_request(:deactivate_campaign_asset, params)
|
|
983
|
+
req.send_request(options)
|
|
984
|
+
end
|
|
985
|
+
|
|
986
|
+
# Permanently deletes a campaign, its assets and their stored files.
|
|
987
|
+
#
|
|
988
|
+
# A hard delete with no undo: the campaign leaves ListCampaigns and
|
|
989
|
+
# every read of it returns ResourceNotFoundException. Its tags are
|
|
990
|
+
# removed with it.
|
|
991
|
+
#
|
|
992
|
+
# Refused with ConflictException while the campaign has a live asset
|
|
993
|
+
# (`CAMPAIGN_HAS_ACTIVE_ASSETS`), because deleting the record would
|
|
994
|
+
# orphan what the delivery platform still serves or sends: deactivate
|
|
995
|
+
# those assets first. Also refused while an activation task is running
|
|
996
|
+
# (`CAMPAIGN_ACTIVATION_IN_PROGRESS`). A completed campaign can be
|
|
997
|
+
# deleted.
|
|
998
|
+
#
|
|
999
|
+
# Idempotent in effect: deleting a campaign that is already gone returns
|
|
1000
|
+
# ResourceNotFoundException, and nothing is left behind by a retry.
|
|
1001
|
+
#
|
|
1002
|
+
# @option params [required, String] :catalog
|
|
1003
|
+
# The catalog (AWS or Sandbox).
|
|
1004
|
+
#
|
|
1005
|
+
# @option params [required, String] :campaign_identifier
|
|
1006
|
+
# The campaign to delete.
|
|
1007
|
+
#
|
|
1008
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1009
|
+
#
|
|
1010
|
+
#
|
|
1011
|
+
# @example Example: Delete a campaign
|
|
1012
|
+
#
|
|
1013
|
+
# resp = client.delete_campaign({
|
|
1014
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1015
|
+
# catalog: "AWS",
|
|
1016
|
+
# })
|
|
1017
|
+
#
|
|
1018
|
+
# @example Request syntax with placeholder values
|
|
1019
|
+
#
|
|
1020
|
+
# resp = client.delete_campaign({
|
|
1021
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1022
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1023
|
+
# })
|
|
1024
|
+
#
|
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteCampaign AWS API Documentation
|
|
1026
|
+
#
|
|
1027
|
+
# @overload delete_campaign(params = {})
|
|
1028
|
+
# @param [Hash] params ({})
|
|
1029
|
+
def delete_campaign(params = {}, options = {})
|
|
1030
|
+
req = build_request(:delete_campaign, params)
|
|
1031
|
+
req.send_request(options)
|
|
1032
|
+
end
|
|
1033
|
+
|
|
1034
|
+
# Permanently deletes a campaign asset.
|
|
1035
|
+
#
|
|
1036
|
+
# @option params [required, String] :catalog
|
|
1037
|
+
# The catalog (AWS or Sandbox).
|
|
1038
|
+
#
|
|
1039
|
+
# @option params [required, String] :campaign_identifier
|
|
1040
|
+
# The campaign identifier.
|
|
1041
|
+
#
|
|
1042
|
+
# @option params [required, String] :campaign_asset_identifier
|
|
1043
|
+
# The asset identifier.
|
|
1044
|
+
#
|
|
1045
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1046
|
+
#
|
|
1047
|
+
#
|
|
1048
|
+
# @example Example: Delete an asset
|
|
1049
|
+
#
|
|
1050
|
+
# resp = client.delete_campaign_asset({
|
|
1051
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
1052
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1053
|
+
# catalog: "AWS",
|
|
1054
|
+
# })
|
|
1055
|
+
#
|
|
1056
|
+
# @example Request syntax with placeholder values
|
|
1057
|
+
#
|
|
1058
|
+
# resp = client.delete_campaign_asset({
|
|
1059
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1060
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1061
|
+
# campaign_asset_identifier: "CampaignAssetId", # required
|
|
1062
|
+
# })
|
|
1063
|
+
#
|
|
1064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteCampaignAsset AWS API Documentation
|
|
1065
|
+
#
|
|
1066
|
+
# @overload delete_campaign_asset(params = {})
|
|
1067
|
+
# @param [Hash] params ({})
|
|
1068
|
+
def delete_campaign_asset(params = {}, options = {})
|
|
1069
|
+
req = build_request(:delete_campaign_asset, params)
|
|
1070
|
+
req.send_request(options)
|
|
1071
|
+
end
|
|
1072
|
+
|
|
1073
|
+
# Revokes and deletes one social connection; other connections on the
|
|
1074
|
+
# same platform are untouched. Idempotent: deleting an unknown or
|
|
1075
|
+
# already-deleted connection succeeds rather than returning a not-found
|
|
1076
|
+
# error.
|
|
1077
|
+
#
|
|
1078
|
+
# @option params [required, String] :catalog
|
|
1079
|
+
# Catalog the connection belongs to.
|
|
1080
|
+
#
|
|
1081
|
+
# @option params [required, String] :identifier
|
|
1082
|
+
# Identifier or ARN of the social connection to delete.
|
|
1083
|
+
#
|
|
1084
|
+
# @option params [String] :client_token
|
|
1085
|
+
# Idempotency token.
|
|
1086
|
+
#
|
|
1087
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1088
|
+
# not need to pass this option.**
|
|
1089
|
+
#
|
|
1090
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1091
|
+
#
|
|
1092
|
+
# @example Request syntax with placeholder values
|
|
1093
|
+
#
|
|
1094
|
+
# resp = client.delete_social_connection({
|
|
1095
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1096
|
+
# identifier: "SocialConnectionIdentifier", # required
|
|
1097
|
+
# client_token: "ClientToken",
|
|
1098
|
+
# })
|
|
1099
|
+
#
|
|
1100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteSocialConnection AWS API Documentation
|
|
1101
|
+
#
|
|
1102
|
+
# @overload delete_social_connection(params = {})
|
|
1103
|
+
# @param [Hash] params ({})
|
|
1104
|
+
def delete_social_connection(params = {}, options = {})
|
|
1105
|
+
req = build_request(:delete_social_connection, params)
|
|
1106
|
+
req.send_request(options)
|
|
1107
|
+
end
|
|
1108
|
+
|
|
1109
|
+
# Retrieves a campaign by its identifier.
|
|
1110
|
+
#
|
|
1111
|
+
# @option params [required, String] :catalog
|
|
1112
|
+
# The catalog (AWS or Sandbox).
|
|
1113
|
+
#
|
|
1114
|
+
# @option params [required, String] :campaign_identifier
|
|
1115
|
+
# The campaign identifier.
|
|
1116
|
+
#
|
|
1117
|
+
# @return [Types::GetCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1118
|
+
#
|
|
1119
|
+
# * {Types::GetCampaignResponse#campaign #campaign} => Types::Campaign
|
|
1120
|
+
#
|
|
1121
|
+
#
|
|
1122
|
+
# @example Example: Get a campaign
|
|
1123
|
+
#
|
|
1124
|
+
# resp = client.get_campaign({
|
|
1125
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1126
|
+
# catalog: "AWS",
|
|
1127
|
+
# })
|
|
1128
|
+
#
|
|
1129
|
+
# resp.to_h outputs the following:
|
|
1130
|
+
# {
|
|
1131
|
+
# campaign: {
|
|
1132
|
+
# activation_issues: [
|
|
1133
|
+
# {
|
|
1134
|
+
# affected_asset_ids: [
|
|
1135
|
+
# "ast-4b81e0c9f2a7b",
|
|
1136
|
+
# ],
|
|
1137
|
+
# campaign_setting: "EMAIL_TARGET",
|
|
1138
|
+
# code: "RECIPIENT_LIST_MISSING",
|
|
1139
|
+
# message: "The campaign has no recipient list.",
|
|
1140
|
+
# },
|
|
1141
|
+
# ],
|
|
1142
|
+
# arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/campaign/camp-5Hq2m8x4k1p9w",
|
|
1143
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
1144
|
+
# name: "Q4 GenAI Campaign",
|
|
1145
|
+
# partner_profile: {
|
|
1146
|
+
# display_name: "Example Partner",
|
|
1147
|
+
# logo_url: "https://d111111abcdef8.cloudfront.net/logos/0f1e2d3c4b5a69788796a5b4c3d2e1f0.png",
|
|
1148
|
+
# refreshed_at: Time.parse("2026-10-05T12:00:00Z"),
|
|
1149
|
+
# website_url: "https://example.com",
|
|
1150
|
+
# },
|
|
1151
|
+
# state: "DRAFT",
|
|
1152
|
+
# },
|
|
1153
|
+
# }
|
|
1154
|
+
#
|
|
1155
|
+
# @example Request syntax with placeholder values
|
|
1156
|
+
#
|
|
1157
|
+
# resp = client.get_campaign({
|
|
1158
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1159
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1160
|
+
# })
|
|
1161
|
+
#
|
|
1162
|
+
# @example Response structure
|
|
1163
|
+
#
|
|
1164
|
+
# resp.campaign.campaign_id #=> String
|
|
1165
|
+
# resp.campaign.arn #=> String
|
|
1166
|
+
# resp.campaign.name #=> String
|
|
1167
|
+
# resp.campaign.state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED"
|
|
1168
|
+
# resp.campaign.campaign_template_id #=> String
|
|
1169
|
+
# resp.campaign.language #=> String, one of "en", "es", "es-419", "fr", "de", "it", "pt-BR", "id", "tr", "ja", "ko", "zh-Hans", "zh-Hant", "ar"
|
|
1170
|
+
# resp.campaign.partner_profile.display_name #=> String
|
|
1171
|
+
# resp.campaign.partner_profile.website_url #=> String
|
|
1172
|
+
# resp.campaign.partner_profile.logo_url #=> String
|
|
1173
|
+
# resp.campaign.partner_profile.refreshed_at #=> Time
|
|
1174
|
+
# resp.campaign.sender_email #=> String
|
|
1175
|
+
# resp.campaign.privacy_policy_url #=> String
|
|
1176
|
+
# resp.campaign.partner_address #=> String
|
|
1177
|
+
# resp.campaign.partner_badge.url #=> String
|
|
1178
|
+
# resp.campaign.partner_badge.attached_at #=> Time
|
|
1179
|
+
# resp.campaign.email_target.scan_status #=> String, one of "PENDING", "CLEAN", "REJECTED"
|
|
1180
|
+
# resp.campaign.email_target.attached_at #=> Time
|
|
1181
|
+
# resp.campaign.email_target.valid_count #=> Integer
|
|
1182
|
+
# resp.campaign.email_target.rejected_count #=> Integer
|
|
1183
|
+
# resp.campaign.email_target.duplicate_count #=> Integer
|
|
1184
|
+
# resp.campaign.email_target.file_name #=> String
|
|
1185
|
+
# resp.campaign.email_target_engagement_group_ids #=> Array
|
|
1186
|
+
# resp.campaign.email_target_engagement_group_ids[0] #=> String
|
|
1187
|
+
# resp.campaign.social_connections #=> Hash
|
|
1188
|
+
# resp.campaign.social_connections["Platform"] #=> Array
|
|
1189
|
+
# resp.campaign.social_connections["Platform"][0] #=> String
|
|
1190
|
+
# resp.campaign.estimated_budget.amount #=> String
|
|
1191
|
+
# resp.campaign.estimated_budget.currency_code #=> String
|
|
1192
|
+
# resp.campaign.total_budget.amount #=> String
|
|
1193
|
+
# resp.campaign.total_budget.currency_code #=> String
|
|
1194
|
+
# resp.campaign.target_audience.industries #=> Array
|
|
1195
|
+
# resp.campaign.target_audience.industries[0] #=> String, one of "FINANCIAL_SERVICES", "HEALTHCARE", "MANUFACTURING", "RETAIL", "MEDIA_ENTERTAINMENT", "ENERGY", "EDUCATION", "GOVERNMENT", "TELECOMMUNICATIONS", "AUTOMOTIVE", "INSURANCE", "OTHER"
|
|
1196
|
+
# resp.campaign.target_audience.company_sizes #=> Array
|
|
1197
|
+
# resp.campaign.target_audience.company_sizes[0] #=> String, one of "STARTUP", "SMALL_BUSINESS", "MID_MARKET", "ENTERPRISE", "GLOBAL_ENTERPRISE"
|
|
1198
|
+
# resp.campaign.target_audience.countries #=> Array
|
|
1199
|
+
# resp.campaign.target_audience.countries[0] #=> String
|
|
1200
|
+
# resp.campaign.start_on #=> String
|
|
1201
|
+
# resp.campaign.end_on #=> String
|
|
1202
|
+
# resp.campaign.created_at #=> Time
|
|
1203
|
+
# resp.campaign.updated_at #=> Time
|
|
1204
|
+
# resp.campaign.activation_issues #=> Array
|
|
1205
|
+
# resp.campaign.activation_issues[0].code #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
1206
|
+
# resp.campaign.activation_issues[0].field_id #=> String
|
|
1207
|
+
# resp.campaign.activation_issues[0].campaign_setting #=> String, one of "SENDER_EMAIL", "END_ON", "EMAIL_TARGET", "PRIVACY_POLICY_URL", "PARTNER_ADDRESS", "PARTNER_BADGE"
|
|
1208
|
+
# resp.campaign.activation_issues[0].partner_profile_field #=> String, one of "DISPLAY_NAME", "WEBSITE_URL", "LOGO", "WEBSITE_DOMAIN", "COPYRIGHT_LINE", "PARTNER_DETAILS", "COPYRIGHT_AND_DETAILS", "COPYRIGHT_YEAR_LINE"
|
|
1209
|
+
# resp.campaign.activation_issues[0].affected_asset_ids #=> Array
|
|
1210
|
+
# resp.campaign.activation_issues[0].affected_asset_ids[0] #=> String
|
|
1211
|
+
# resp.campaign.activation_issues[0].message #=> String
|
|
1212
|
+
#
|
|
1213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaign AWS API Documentation
|
|
1214
|
+
#
|
|
1215
|
+
# @overload get_campaign(params = {})
|
|
1216
|
+
# @param [Hash] params ({})
|
|
1217
|
+
def get_campaign(params = {}, options = {})
|
|
1218
|
+
req = build_request(:get_campaign, params)
|
|
1219
|
+
req.send_request(options)
|
|
1220
|
+
end
|
|
1221
|
+
|
|
1222
|
+
# Retrieves an asset by its identifier.
|
|
1223
|
+
#
|
|
1224
|
+
# @option params [required, String] :catalog
|
|
1225
|
+
# The catalog (AWS or Sandbox).
|
|
1226
|
+
#
|
|
1227
|
+
# @option params [required, String] :campaign_identifier
|
|
1228
|
+
# The campaign identifier.
|
|
1229
|
+
#
|
|
1230
|
+
# @option params [required, String] :campaign_asset_identifier
|
|
1231
|
+
# The asset identifier.
|
|
1232
|
+
#
|
|
1233
|
+
# @return [Types::GetCampaignAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1234
|
+
#
|
|
1235
|
+
# * {Types::GetCampaignAssetResponse#asset #asset} => Types::CampaignAsset
|
|
1236
|
+
#
|
|
1237
|
+
#
|
|
1238
|
+
# @example Example: Get an asset
|
|
1239
|
+
#
|
|
1240
|
+
# resp = client.get_campaign_asset({
|
|
1241
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
1242
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1243
|
+
# catalog: "AWS",
|
|
1244
|
+
# })
|
|
1245
|
+
#
|
|
1246
|
+
# resp.to_h outputs the following:
|
|
1247
|
+
# {
|
|
1248
|
+
# asset: {
|
|
1249
|
+
# activation_issues: [
|
|
1250
|
+
# ],
|
|
1251
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
1252
|
+
# category: "EMAIL",
|
|
1253
|
+
# delivery_status: "PENDING",
|
|
1254
|
+
# file_format: "HTML",
|
|
1255
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
1256
|
+
# last_activation_status: "SUCCEEDED",
|
|
1257
|
+
# name: "Intro email",
|
|
1258
|
+
# state: "ACTIVE",
|
|
1259
|
+
# },
|
|
1260
|
+
# }
|
|
1261
|
+
#
|
|
1262
|
+
# @example Request syntax with placeholder values
|
|
1263
|
+
#
|
|
1264
|
+
# resp = client.get_campaign_asset({
|
|
1265
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1266
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1267
|
+
# campaign_asset_identifier: "CampaignAssetId", # required
|
|
1268
|
+
# })
|
|
1269
|
+
#
|
|
1270
|
+
# @example Response structure
|
|
1271
|
+
#
|
|
1272
|
+
# resp.asset.id #=> String
|
|
1273
|
+
# resp.asset.campaign_id #=> String
|
|
1274
|
+
# resp.asset.category #=> String, one of "EMAIL", "LANDING_PAGE", "SOCIAL_POST", "BANNER_AD", "DOCUMENT"
|
|
1275
|
+
# resp.asset.name #=> String
|
|
1276
|
+
# resp.asset.link_label #=> String
|
|
1277
|
+
# resp.asset.state #=> String, one of "INACTIVE", "ACTIVE"
|
|
1278
|
+
# resp.asset.last_activation_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
1279
|
+
# resp.asset.delivery_status #=> String, one of "PENDING", "DELIVERED", "FAILED"
|
|
1280
|
+
# resp.asset.delivery_status_reason #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
1281
|
+
# resp.asset.source_asset_template_id #=> String
|
|
1282
|
+
# resp.asset.social_platform #=> String, one of "FACEBOOK", "LINKEDIN", "X"
|
|
1283
|
+
# resp.asset.file_format #=> String, one of "PDF", "DOCX", "PPTX", "HTML", "IMAGE"
|
|
1284
|
+
# resp.asset.send_mode #=> String, one of "ON_ACTIVATION", "SCHEDULED"
|
|
1285
|
+
# resp.asset.scheduled_send_at #=> Time
|
|
1286
|
+
# resp.asset.field_values #=> Array
|
|
1287
|
+
# resp.asset.field_values[0].field.field_id #=> String
|
|
1288
|
+
# resp.asset.field_values[0].field.label #=> String
|
|
1289
|
+
# resp.asset.field_values[0].field.description #=> String
|
|
1290
|
+
# resp.asset.field_values[0].field.section #=> String, one of "HEADER", "BODY", "FOOTER"
|
|
1291
|
+
# resp.asset.field_values[0].field.page #=> Integer
|
|
1292
|
+
# resp.asset.field_values[0].field.required #=> Boolean
|
|
1293
|
+
# resp.asset.field_values[0].field.type.text.min_length #=> Integer
|
|
1294
|
+
# resp.asset.field_values[0].field.type.text.max_length #=> Integer
|
|
1295
|
+
# resp.asset.field_values[0].field.type.text.pattern #=> String
|
|
1296
|
+
# resp.asset.field_values[0].field.type.text.placeholder #=> String
|
|
1297
|
+
# resp.asset.field_values[0].field.type.rich_text.max_length #=> Integer
|
|
1298
|
+
# resp.asset.field_values[0].field.type.rich_text.allowed_tags #=> Array
|
|
1299
|
+
# resp.asset.field_values[0].field.type.rich_text.allowed_tags[0] #=> String
|
|
1300
|
+
# resp.asset.field_values[0].field.type.rich_text.placeholder #=> String
|
|
1301
|
+
# resp.asset.field_values[0].field.type.image.max_size_bytes #=> Integer
|
|
1302
|
+
# resp.asset.field_values[0].field.type.image.allowed_formats #=> Array
|
|
1303
|
+
# resp.asset.field_values[0].field.type.image.allowed_formats[0] #=> String, one of "PNG", "JPEG"
|
|
1304
|
+
# resp.asset.field_values[0].field.type.image.default_value.format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
1305
|
+
# resp.asset.field_values[0].field.type.image.default_value.url #=> String
|
|
1306
|
+
# resp.asset.field_values[0].field.type.image.default_value.page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
1307
|
+
# resp.asset.field_values[0].field.type.image.recommended_width_pixels #=> Integer
|
|
1308
|
+
# resp.asset.field_values[0].field.type.image.recommended_height_pixels #=> Integer
|
|
1309
|
+
# resp.asset.field_values[0].field.type.asset_link.category #=> String, one of "EMAIL", "LANDING_PAGE", "SOCIAL_POST", "BANNER_AD", "DOCUMENT"
|
|
1310
|
+
# resp.asset.field_values[0].field.type.asset_link.label_field_id #=> String
|
|
1311
|
+
# resp.asset.field_values[0].field.campaign_setting #=> String, one of "SENDER_EMAIL", "END_ON", "EMAIL_TARGET", "PRIVACY_POLICY_URL", "PARTNER_ADDRESS", "PARTNER_BADGE"
|
|
1312
|
+
# resp.asset.field_values[0].field.partner_profile_field #=> String, one of "DISPLAY_NAME", "WEBSITE_URL", "LOGO", "WEBSITE_DOMAIN", "COPYRIGHT_LINE", "PARTNER_DETAILS", "COPYRIGHT_AND_DETAILS", "COPYRIGHT_YEAR_LINE"
|
|
1313
|
+
# resp.asset.field_values[0].value.text #=> String
|
|
1314
|
+
# resp.asset.field_values[0].value.image_reference #=> String
|
|
1315
|
+
# resp.asset.field_values[0].value.linked_asset_id #=> String
|
|
1316
|
+
# resp.asset.field_values[0].value.campaign_asset_image.campaign_identifier #=> String
|
|
1317
|
+
# resp.asset.field_values[0].value.campaign_asset_image.campaign_asset_identifier #=> String
|
|
1318
|
+
# resp.asset.field_values[0].value.campaign_asset_image.field_id #=> String
|
|
1319
|
+
# resp.asset.layout_previews #=> Array
|
|
1320
|
+
# resp.asset.layout_previews[0].format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
1321
|
+
# resp.asset.layout_previews[0].url #=> String
|
|
1322
|
+
# resp.asset.layout_previews[0].page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
1323
|
+
# resp.asset.layout.selected #=> String
|
|
1324
|
+
# resp.asset.layout.options #=> Array
|
|
1325
|
+
# resp.asset.layout.options[0].value #=> String
|
|
1326
|
+
# resp.asset.layout.options[0].label #=> String
|
|
1327
|
+
# resp.asset.layout.options[0].field_ids #=> Array
|
|
1328
|
+
# resp.asset.layout.options[0].field_ids[0] #=> String
|
|
1329
|
+
# resp.asset.layout.options[0].layout_previews #=> Array
|
|
1330
|
+
# resp.asset.layout.options[0].layout_previews[0].format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
1331
|
+
# resp.asset.layout.options[0].layout_previews[0].url #=> String
|
|
1332
|
+
# resp.asset.layout.options[0].layout_previews[0].page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
1333
|
+
# resp.asset.activation_issues #=> Array
|
|
1334
|
+
# resp.asset.activation_issues[0].code #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
1335
|
+
# resp.asset.activation_issues[0].field_id #=> String
|
|
1336
|
+
# resp.asset.activation_issues[0].campaign_setting #=> String, one of "SENDER_EMAIL", "END_ON", "EMAIL_TARGET", "PRIVACY_POLICY_URL", "PARTNER_ADDRESS", "PARTNER_BADGE"
|
|
1337
|
+
# resp.asset.activation_issues[0].partner_profile_field #=> String, one of "DISPLAY_NAME", "WEBSITE_URL", "LOGO", "WEBSITE_DOMAIN", "COPYRIGHT_LINE", "PARTNER_DETAILS", "COPYRIGHT_AND_DETAILS", "COPYRIGHT_YEAR_LINE"
|
|
1338
|
+
# resp.asset.activation_issues[0].affected_asset_ids #=> Array
|
|
1339
|
+
# resp.asset.activation_issues[0].affected_asset_ids[0] #=> String
|
|
1340
|
+
# resp.asset.activation_issues[0].message #=> String
|
|
1341
|
+
# resp.asset.public_url #=> String
|
|
1342
|
+
# resp.asset.created_at #=> Time
|
|
1343
|
+
# resp.asset.updated_at #=> Time
|
|
1344
|
+
#
|
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAsset AWS API Documentation
|
|
1346
|
+
#
|
|
1347
|
+
# @overload get_campaign_asset(params = {})
|
|
1348
|
+
# @param [Hash] params ({})
|
|
1349
|
+
def get_campaign_asset(params = {}, options = {})
|
|
1350
|
+
req = build_request(:get_campaign_asset, params)
|
|
1351
|
+
req.send_request(options)
|
|
1352
|
+
end
|
|
1353
|
+
|
|
1354
|
+
# Reads a campaign's current activation task.
|
|
1355
|
+
#
|
|
1356
|
+
# Keyed on the **campaign**, with no task identifier, because a campaign
|
|
1357
|
+
# has at most one activation task: runs are serialised, so there is no
|
|
1358
|
+
# collection to address into. The caller always holds the task id
|
|
1359
|
+
# anyway, because Start returned it — the id is a correlation value, not
|
|
1360
|
+
# an address.
|
|
1361
|
+
#
|
|
1362
|
+
# Returns the campaign's most recent task. A new task overwrites the
|
|
1363
|
+
# previous one, so this is not a history: the durable per-asset record
|
|
1364
|
+
# is on the assets themselves. Returns ResourceNotFoundException when
|
|
1365
|
+
# the campaign has never had a task, or when its last one has expired.
|
|
1366
|
+
#
|
|
1367
|
+
# @option params [required, String] :catalog
|
|
1368
|
+
# The catalog (AWS or Sandbox).
|
|
1369
|
+
#
|
|
1370
|
+
# @option params [required, String] :campaign_identifier
|
|
1371
|
+
# The campaign whose current task to read. This addresses the task, and
|
|
1372
|
+
# also authorizes the call.
|
|
1373
|
+
#
|
|
1374
|
+
# @return [Types::GetCampaignAssetActivationTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1375
|
+
#
|
|
1376
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#campaign_id #campaign_id} => String
|
|
1377
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#task_id #task_id} => String
|
|
1378
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#task_status #task_status} => String
|
|
1379
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#started_at #started_at} => Time
|
|
1380
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#ended_at #ended_at} => Time
|
|
1381
|
+
# * {Types::GetCampaignAssetActivationTaskResponse#assets #assets} => Array<Types::CampaignAssetActivationOutcome>
|
|
1382
|
+
#
|
|
1383
|
+
#
|
|
1384
|
+
# @example Example: Read a finished task where one asset failed
|
|
1385
|
+
#
|
|
1386
|
+
# resp = client.get_campaign_asset_activation_task({
|
|
1387
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1388
|
+
# catalog: "AWS",
|
|
1389
|
+
# })
|
|
1390
|
+
#
|
|
1391
|
+
# resp.to_h outputs the following:
|
|
1392
|
+
# {
|
|
1393
|
+
# assets: [
|
|
1394
|
+
# {
|
|
1395
|
+
# campaign_asset_id: "ast-4b81e0c9f2a7b",
|
|
1396
|
+
# status: "SUCCEEDED",
|
|
1397
|
+
# },
|
|
1398
|
+
# {
|
|
1399
|
+
# campaign_asset_id: "ast-9f3c1a2b7d40e",
|
|
1400
|
+
# status: "SUCCEEDED",
|
|
1401
|
+
# },
|
|
1402
|
+
# {
|
|
1403
|
+
# campaign_asset_id: "ast-2k7m4p9x1c6qd",
|
|
1404
|
+
# status: "SUCCEEDED",
|
|
1405
|
+
# },
|
|
1406
|
+
# {
|
|
1407
|
+
# campaign_asset_id: "ast-7w3n8r5t2h1ya",
|
|
1408
|
+
# message: "The connected social account is no longer authorized.",
|
|
1409
|
+
# reason: "SOCIAL_CONNECTION_EXPIRED",
|
|
1410
|
+
# status: "FAILED",
|
|
1411
|
+
# },
|
|
1412
|
+
# ],
|
|
1413
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
1414
|
+
# ended_at: Time.parse(1764547431),
|
|
1415
|
+
# started_at: Time.parse(1764547200),
|
|
1416
|
+
# task_id: "atsk-7k2M9x4qp1w8n",
|
|
1417
|
+
# task_status: "PARTIAL_FAILURE",
|
|
1418
|
+
# }
|
|
1419
|
+
#
|
|
1420
|
+
# @example Request syntax with placeholder values
|
|
1421
|
+
#
|
|
1422
|
+
# resp = client.get_campaign_asset_activation_task({
|
|
1423
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1424
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1425
|
+
# })
|
|
1426
|
+
#
|
|
1427
|
+
# @example Response structure
|
|
1428
|
+
#
|
|
1429
|
+
# resp.campaign_id #=> String
|
|
1430
|
+
# resp.task_id #=> String
|
|
1431
|
+
# resp.task_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "PARTIAL_FAILURE", "FAILED"
|
|
1432
|
+
# resp.started_at #=> Time
|
|
1433
|
+
# resp.ended_at #=> Time
|
|
1434
|
+
# resp.assets #=> Array
|
|
1435
|
+
# resp.assets[0].campaign_asset_id #=> String
|
|
1436
|
+
# resp.assets[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
1437
|
+
# resp.assets[0].reason #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
1438
|
+
# resp.assets[0].message #=> String
|
|
1439
|
+
#
|
|
1440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetActivationTask AWS API Documentation
|
|
1441
|
+
#
|
|
1442
|
+
# @overload get_campaign_asset_activation_task(params = {})
|
|
1443
|
+
# @param [Hash] params ({})
|
|
1444
|
+
def get_campaign_asset_activation_task(params = {}, options = {})
|
|
1445
|
+
req = build_request(:get_campaign_asset_activation_task, params)
|
|
1446
|
+
req.send_request(options)
|
|
1447
|
+
end
|
|
1448
|
+
|
|
1449
|
+
# Retrieves a campaign asset export task by its identifier, reporting
|
|
1450
|
+
# its status and, when the task is COMPLETED, a freshly minted
|
|
1451
|
+
# short-lived presigned URL for downloading the ZIP archive.
|
|
1452
|
+
#
|
|
1453
|
+
# The download URL is minted on each call and is valid for at most 15
|
|
1454
|
+
# minutes; clients should download promptly rather than caching it. When
|
|
1455
|
+
# the task has FAILED, FailureReason explains why. Poll this operation
|
|
1456
|
+
# (roughly every 2-5 seconds) until the task reaches a terminal state.
|
|
1457
|
+
#
|
|
1458
|
+
# @option params [required, String] :catalog
|
|
1459
|
+
# The catalog (AWS or Sandbox).
|
|
1460
|
+
#
|
|
1461
|
+
# @option params [required, String] :campaign_identifier
|
|
1462
|
+
# The campaign that owns the export task. Accepts the campaign id or
|
|
1463
|
+
# ARN. Required so the read is authorized on campaign/\{CampaignId}; the
|
|
1464
|
+
# task must belong to this campaign or the request resolves to
|
|
1465
|
+
# not-found.
|
|
1466
|
+
#
|
|
1467
|
+
# @option params [required, String] :campaign_asset_export_task_identifier
|
|
1468
|
+
# The export task to retrieve: the `Id` StartCampaignAssetExportTask
|
|
1469
|
+
# returned (`etsk-…`).
|
|
1470
|
+
#
|
|
1471
|
+
# An id only. An export task has no ARN: none is returned, recorded or
|
|
1472
|
+
# authorized on (the read authorizes on its campaign), so there is no
|
|
1473
|
+
# ARN to accept (DG-063 D-35).
|
|
1474
|
+
#
|
|
1475
|
+
# @return [Types::GetCampaignAssetExportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1476
|
+
#
|
|
1477
|
+
# * {Types::GetCampaignAssetExportTaskResponse#id #id} => String
|
|
1478
|
+
# * {Types::GetCampaignAssetExportTaskResponse#status #status} => String
|
|
1479
|
+
# * {Types::GetCampaignAssetExportTaskResponse#created_at #created_at} => Time
|
|
1480
|
+
# * {Types::GetCampaignAssetExportTaskResponse#download_url #download_url} => String
|
|
1481
|
+
# * {Types::GetCampaignAssetExportTaskResponse#expires_at #expires_at} => Time
|
|
1482
|
+
# * {Types::GetCampaignAssetExportTaskResponse#failure_reason #failure_reason} => Types::CampaignAssetExportFailureReason
|
|
1483
|
+
#
|
|
1484
|
+
# @example Request syntax with placeholder values
|
|
1485
|
+
#
|
|
1486
|
+
# resp = client.get_campaign_asset_export_task({
|
|
1487
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1488
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1489
|
+
# campaign_asset_export_task_identifier: "CampaignAssetExportTaskId", # required
|
|
1490
|
+
# })
|
|
1491
|
+
#
|
|
1492
|
+
# @example Response structure
|
|
1493
|
+
#
|
|
1494
|
+
# resp.id #=> String
|
|
1495
|
+
# resp.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
|
1496
|
+
# resp.created_at #=> Time
|
|
1497
|
+
# resp.download_url #=> String
|
|
1498
|
+
# resp.expires_at #=> Time
|
|
1499
|
+
# resp.failure_reason.code #=> String, one of "EXPORT_TIMEOUT", "EXPORT_TOO_LARGE", "PACKAGING_ERROR", "SOURCE_OBJECT_MISSING", "INTERNAL_ERROR"
|
|
1500
|
+
# resp.failure_reason.message #=> String
|
|
1501
|
+
#
|
|
1502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetExportTask AWS API Documentation
|
|
1503
|
+
#
|
|
1504
|
+
# @overload get_campaign_asset_export_task(params = {})
|
|
1505
|
+
# @param [Hash] params ({})
|
|
1506
|
+
def get_campaign_asset_export_task(params = {}, options = {})
|
|
1507
|
+
req = build_request(:get_campaign_asset_export_task, params)
|
|
1508
|
+
req.send_request(options)
|
|
1509
|
+
end
|
|
1510
|
+
|
|
1511
|
+
# Retrieves full detail of one campaign template, including its ordered
|
|
1512
|
+
# asset templates with their field schema and layout previews.
|
|
1513
|
+
#
|
|
1514
|
+
# @option params [required, String] :catalog
|
|
1515
|
+
# The catalog (AWS or Sandbox).
|
|
1516
|
+
#
|
|
1517
|
+
# @option params [required, String] :identifier
|
|
1518
|
+
# The campaign template's id. A campaign template has no ARN (DG-084).
|
|
1519
|
+
#
|
|
1520
|
+
# @return [Types::GetCampaignTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1521
|
+
#
|
|
1522
|
+
# * {Types::GetCampaignTemplateResponse#campaign_template #campaign_template} => Types::CampaignTemplate
|
|
1523
|
+
#
|
|
1524
|
+
#
|
|
1525
|
+
# @example Example: Get a campaign template
|
|
1526
|
+
#
|
|
1527
|
+
# resp = client.get_campaign_template({
|
|
1528
|
+
# catalog: "AWS",
|
|
1529
|
+
# identifier: "tmpl-987xyz654abcd",
|
|
1530
|
+
# })
|
|
1531
|
+
#
|
|
1532
|
+
# resp.to_h outputs the following:
|
|
1533
|
+
# {
|
|
1534
|
+
# campaign_template: {
|
|
1535
|
+
# collection: "GENERAL",
|
|
1536
|
+
# id: "tmpl-987xyz654abcd",
|
|
1537
|
+
# name: "GenAI for Financial Services",
|
|
1538
|
+
# },
|
|
1539
|
+
# }
|
|
1540
|
+
#
|
|
1541
|
+
# @example Request syntax with placeholder values
|
|
1542
|
+
#
|
|
1543
|
+
# resp = client.get_campaign_template({
|
|
1544
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1545
|
+
# identifier: "CampaignTemplateId", # required
|
|
1546
|
+
# })
|
|
1547
|
+
#
|
|
1548
|
+
# @example Response structure
|
|
1549
|
+
#
|
|
1550
|
+
# resp.campaign_template.id #=> String
|
|
1551
|
+
# resp.campaign_template.name #=> String
|
|
1552
|
+
# resp.campaign_template.industry #=> String, one of "FINANCIAL_SERVICES", "HEALTHCARE", "MANUFACTURING", "RETAIL", "MEDIA_ENTERTAINMENT", "ENERGY", "EDUCATION", "GOVERNMENT", "TELECOMMUNICATIONS", "AUTOMOTIVE", "INSURANCE", "OTHER"
|
|
1553
|
+
# resp.campaign_template.use_case #=> String
|
|
1554
|
+
# resp.campaign_template.description #=> String
|
|
1555
|
+
# resp.campaign_template.language_code #=> String, one of "en", "es", "es-419", "fr", "de", "it", "pt-BR", "id", "tr", "ja", "ko", "zh-Hans", "zh-Hant", "ar"
|
|
1556
|
+
# resp.campaign_template.collection #=> String, one of "GENERAL", "BUILD_WITH_AI"
|
|
1557
|
+
# resp.campaign_template.aws_services #=> Array
|
|
1558
|
+
# resp.campaign_template.aws_services[0] #=> String
|
|
1559
|
+
# resp.campaign_template.customer_segments #=> Array
|
|
1560
|
+
# resp.campaign_template.customer_segments[0] #=> String, one of "ENTERPRISE", "SMB", "PUBLIC_SECTOR", "ISV"
|
|
1561
|
+
# resp.campaign_template.themes #=> Array
|
|
1562
|
+
# resp.campaign_template.themes[0] #=> String, one of "AI", "MIGRATION_MODERNIZATION", "SECURITY", "DATA_ANALYTICS", "AWS_TRAINING_CERTIFICATION", "AWS_MARKETPLACE", "CONNECT", "EVENTS"
|
|
1563
|
+
# resp.campaign_template.setup_duration #=> String
|
|
1564
|
+
# resp.campaign_template.thumbnail_url #=> String
|
|
1565
|
+
# resp.campaign_template.effective_date_begin #=> Time
|
|
1566
|
+
# resp.campaign_template.asset_templates #=> Array
|
|
1567
|
+
# resp.campaign_template.asset_templates[0].id #=> String
|
|
1568
|
+
# resp.campaign_template.asset_templates[0].type #=> String, one of "EMAIL", "SOCIAL_POST", "LANDING_PAGE", "BANNER_AD", "DOCUMENT"
|
|
1569
|
+
# resp.campaign_template.asset_templates[0].label #=> String
|
|
1570
|
+
# resp.campaign_template.asset_templates[0].display_order #=> Integer
|
|
1571
|
+
# resp.campaign_template.asset_templates[0].fields #=> Array
|
|
1572
|
+
# resp.campaign_template.asset_templates[0].fields[0].field_id #=> String
|
|
1573
|
+
# resp.campaign_template.asset_templates[0].fields[0].label #=> String
|
|
1574
|
+
# resp.campaign_template.asset_templates[0].fields[0].description #=> String
|
|
1575
|
+
# resp.campaign_template.asset_templates[0].fields[0].section #=> String, one of "HEADER", "BODY", "FOOTER"
|
|
1576
|
+
# resp.campaign_template.asset_templates[0].fields[0].page #=> Integer
|
|
1577
|
+
# resp.campaign_template.asset_templates[0].fields[0].required #=> Boolean
|
|
1578
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.text.min_length #=> Integer
|
|
1579
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.text.max_length #=> Integer
|
|
1580
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.text.pattern #=> String
|
|
1581
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.text.placeholder #=> String
|
|
1582
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.rich_text.max_length #=> Integer
|
|
1583
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.rich_text.allowed_tags #=> Array
|
|
1584
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.rich_text.allowed_tags[0] #=> String
|
|
1585
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.rich_text.placeholder #=> String
|
|
1586
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.max_size_bytes #=> Integer
|
|
1587
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.allowed_formats #=> Array
|
|
1588
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.allowed_formats[0] #=> String, one of "PNG", "JPEG"
|
|
1589
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.default_value.format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
1590
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.default_value.url #=> String
|
|
1591
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.default_value.page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
1592
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.recommended_width_pixels #=> Integer
|
|
1593
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.image.recommended_height_pixels #=> Integer
|
|
1594
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.asset_link.category #=> String, one of "EMAIL", "LANDING_PAGE", "SOCIAL_POST", "BANNER_AD", "DOCUMENT"
|
|
1595
|
+
# resp.campaign_template.asset_templates[0].fields[0].type.asset_link.label_field_id #=> String
|
|
1596
|
+
# resp.campaign_template.asset_templates[0].fields[0].campaign_setting #=> String, one of "SENDER_EMAIL", "END_ON", "EMAIL_TARGET", "PRIVACY_POLICY_URL", "PARTNER_ADDRESS", "PARTNER_BADGE"
|
|
1597
|
+
# resp.campaign_template.asset_templates[0].fields[0].partner_profile_field #=> String, one of "DISPLAY_NAME", "WEBSITE_URL", "LOGO", "WEBSITE_DOMAIN", "COPYRIGHT_LINE", "PARTNER_DETAILS", "COPYRIGHT_AND_DETAILS", "COPYRIGHT_YEAR_LINE"
|
|
1598
|
+
# resp.campaign_template.asset_templates[0].layout_previews #=> Array
|
|
1599
|
+
# resp.campaign_template.asset_templates[0].layout_previews[0].format #=> String, one of "HTML", "PDF", "IMAGE"
|
|
1600
|
+
# resp.campaign_template.asset_templates[0].layout_previews[0].url #=> String
|
|
1601
|
+
# resp.campaign_template.asset_templates[0].layout_previews[0].page_type #=> String, one of "FORM", "CONFIRMATION"
|
|
1602
|
+
# resp.campaign_template.asset_templates[0].prerequisite_asset_template_ids #=> Array
|
|
1603
|
+
# resp.campaign_template.asset_templates[0].prerequisite_asset_template_ids[0] #=> String
|
|
1604
|
+
# resp.campaign_template.asset_templates[0].social_platform #=> String, one of "FACEBOOK", "LINKEDIN", "X"
|
|
1605
|
+
# resp.campaign_template.reference_materials #=> Array
|
|
1606
|
+
# resp.campaign_template.reference_materials[0].name #=> String
|
|
1607
|
+
# resp.campaign_template.reference_materials[0].url #=> String
|
|
1608
|
+
# resp.campaign_template.created_at #=> Time
|
|
1609
|
+
# resp.campaign_template.updated_at #=> Time
|
|
1610
|
+
#
|
|
1611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignTemplate AWS API Documentation
|
|
1612
|
+
#
|
|
1613
|
+
# @overload get_campaign_template(params = {})
|
|
1614
|
+
# @param [Hash] params ({})
|
|
1615
|
+
def get_campaign_template(params = {}, options = {})
|
|
1616
|
+
req = build_request(:get_campaign_template, params)
|
|
1617
|
+
req.send_request(options)
|
|
1618
|
+
end
|
|
1619
|
+
|
|
1620
|
+
# Lists assets for a campaign with pagination.
|
|
1621
|
+
#
|
|
1622
|
+
# @option params [required, String] :catalog
|
|
1623
|
+
# The catalog (AWS or Sandbox).
|
|
1624
|
+
#
|
|
1625
|
+
# @option params [required, String] :campaign_identifier
|
|
1626
|
+
# The campaign identifier.
|
|
1627
|
+
#
|
|
1628
|
+
# @option params [Integer] :max_results
|
|
1629
|
+
# Maximum results per page.
|
|
1630
|
+
#
|
|
1631
|
+
# @option params [String] :next_token
|
|
1632
|
+
# Pagination token.
|
|
1633
|
+
#
|
|
1634
|
+
# @return [Types::ListCampaignAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1635
|
+
#
|
|
1636
|
+
# * {Types::ListCampaignAssetsResponse#items #items} => Array<Types::CampaignAssetSummary>
|
|
1637
|
+
# * {Types::ListCampaignAssetsResponse#next_token #next_token} => String
|
|
1638
|
+
#
|
|
1639
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1640
|
+
#
|
|
1641
|
+
#
|
|
1642
|
+
# @example Example: List assets for a campaign
|
|
1643
|
+
#
|
|
1644
|
+
# resp = client.list_campaign_assets({
|
|
1645
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
1646
|
+
# catalog: "AWS",
|
|
1647
|
+
# })
|
|
1648
|
+
#
|
|
1649
|
+
# resp.to_h outputs the following:
|
|
1650
|
+
# {
|
|
1651
|
+
# items: [
|
|
1652
|
+
# ],
|
|
1653
|
+
# }
|
|
1654
|
+
#
|
|
1655
|
+
# @example Request syntax with placeholder values
|
|
1656
|
+
#
|
|
1657
|
+
# resp = client.list_campaign_assets({
|
|
1658
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1659
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
1660
|
+
# max_results: 1,
|
|
1661
|
+
# next_token: "NextToken",
|
|
1662
|
+
# })
|
|
1663
|
+
#
|
|
1664
|
+
# @example Response structure
|
|
1665
|
+
#
|
|
1666
|
+
# resp.items #=> Array
|
|
1667
|
+
# resp.items[0].id #=> String
|
|
1668
|
+
# resp.items[0].category #=> String, one of "EMAIL", "LANDING_PAGE", "SOCIAL_POST", "BANNER_AD", "DOCUMENT"
|
|
1669
|
+
# resp.items[0].name #=> String
|
|
1670
|
+
# resp.items[0].link_label #=> String
|
|
1671
|
+
# resp.items[0].state #=> String, one of "INACTIVE", "ACTIVE"
|
|
1672
|
+
# resp.items[0].last_activation_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
1673
|
+
# resp.items[0].delivery_status #=> String, one of "PENDING", "DELIVERED", "FAILED"
|
|
1674
|
+
# resp.items[0].delivery_status_reason #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
1675
|
+
# resp.items[0].source_asset_template_id #=> String
|
|
1676
|
+
# resp.items[0].social_platform #=> String, one of "FACEBOOK", "LINKEDIN", "X"
|
|
1677
|
+
# resp.items[0].started_at #=> Time
|
|
1678
|
+
# resp.items[0].file_format #=> String, one of "PDF", "DOCX", "PPTX", "HTML", "IMAGE"
|
|
1679
|
+
# resp.items[0].send_mode #=> String, one of "ON_ACTIVATION", "SCHEDULED"
|
|
1680
|
+
# resp.items[0].scheduled_send_at #=> Time
|
|
1681
|
+
# resp.next_token #=> String
|
|
1682
|
+
#
|
|
1683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaignAssets AWS API Documentation
|
|
1684
|
+
#
|
|
1685
|
+
# @overload list_campaign_assets(params = {})
|
|
1686
|
+
# @param [Hash] params ({})
|
|
1687
|
+
def list_campaign_assets(params = {}, options = {})
|
|
1688
|
+
req = build_request(:list_campaign_assets, params)
|
|
1689
|
+
req.send_request(options)
|
|
1690
|
+
end
|
|
1691
|
+
|
|
1692
|
+
# Lists campaigns with optional filters and pagination.
|
|
1693
|
+
#
|
|
1694
|
+
# @option params [required, String] :catalog
|
|
1695
|
+
# The catalog (AWS or Sandbox).
|
|
1696
|
+
#
|
|
1697
|
+
# @option params [Array<String>] :campaign_identifiers
|
|
1698
|
+
# Only these campaigns, each named by its id or its campaign ARN. A
|
|
1699
|
+
# campaign that does not exist, was deleted, or whose ARN names another
|
|
1700
|
+
# account or catalog is left out rather than refused.
|
|
1701
|
+
#
|
|
1702
|
+
# @option params [String] :name
|
|
1703
|
+
# Only campaigns whose name contains this, compared case-insensitively.
|
|
1704
|
+
#
|
|
1705
|
+
# @option params [Array<String>] :states
|
|
1706
|
+
# Only campaigns in one of these states.
|
|
1707
|
+
#
|
|
1708
|
+
# @option params [Types::CampaignSort] :sort
|
|
1709
|
+
# The order of the results. Default: `CREATED_AT`, `DESCENDING`.
|
|
1710
|
+
#
|
|
1711
|
+
# @option params [Integer] :max_results
|
|
1712
|
+
# Maximum results per page.
|
|
1713
|
+
#
|
|
1714
|
+
# @option params [String] :next_token
|
|
1715
|
+
# Pagination token. Bound to the filters and sort it was issued for: a
|
|
1716
|
+
# request that changes `CampaignIdentifiers`, `Name`, `States` or `Sort`
|
|
1717
|
+
# between pages is refused with `ValidationException`. `MaxResults` may
|
|
1718
|
+
# change.
|
|
1719
|
+
#
|
|
1720
|
+
# @return [Types::ListCampaignsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1721
|
+
#
|
|
1722
|
+
# * {Types::ListCampaignsResponse#items #items} => Array<Types::CampaignSummary>
|
|
1723
|
+
# * {Types::ListCampaignsResponse#next_token #next_token} => String
|
|
1724
|
+
#
|
|
1725
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1726
|
+
#
|
|
1727
|
+
#
|
|
1728
|
+
# @example Example: List campaigns
|
|
1729
|
+
#
|
|
1730
|
+
# resp = client.list_campaigns({
|
|
1731
|
+
# catalog: "AWS",
|
|
1732
|
+
# })
|
|
1733
|
+
#
|
|
1734
|
+
# resp.to_h outputs the following:
|
|
1735
|
+
# {
|
|
1736
|
+
# items: [
|
|
1737
|
+
# ],
|
|
1738
|
+
# }
|
|
1739
|
+
#
|
|
1740
|
+
# @example Example: Name the campaigns a page links to
|
|
1741
|
+
#
|
|
1742
|
+
# resp = client.list_campaigns({
|
|
1743
|
+
# campaign_identifiers: [
|
|
1744
|
+
# "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/campaign/camp-5Hq2m8x4k1p9w",
|
|
1745
|
+
# "camp-8Rt3w6y1n4b2v",
|
|
1746
|
+
# ],
|
|
1747
|
+
# catalog: "AWS",
|
|
1748
|
+
# })
|
|
1749
|
+
#
|
|
1750
|
+
# resp.to_h outputs the following:
|
|
1751
|
+
# {
|
|
1752
|
+
# items: [
|
|
1753
|
+
# {
|
|
1754
|
+
# arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/campaign/camp-5Hq2m8x4k1p9w",
|
|
1755
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
1756
|
+
# name: "Q4 GenAI Campaign",
|
|
1757
|
+
# start_on: "2026-11-01",
|
|
1758
|
+
# state: "ACTIVE",
|
|
1759
|
+
# },
|
|
1760
|
+
# ],
|
|
1761
|
+
# }
|
|
1762
|
+
#
|
|
1763
|
+
# @example Example: Search active campaigns by name, by launch date
|
|
1764
|
+
#
|
|
1765
|
+
# resp = client.list_campaigns({
|
|
1766
|
+
# catalog: "AWS",
|
|
1767
|
+
# max_results: 20,
|
|
1768
|
+
# name: "genai",
|
|
1769
|
+
# sort: {
|
|
1770
|
+
# sort_by: "START_ON",
|
|
1771
|
+
# sort_order: "ASCENDING",
|
|
1772
|
+
# },
|
|
1773
|
+
# states: [
|
|
1774
|
+
# "ACTIVE",
|
|
1775
|
+
# ],
|
|
1776
|
+
# })
|
|
1777
|
+
#
|
|
1778
|
+
# resp.to_h outputs the following:
|
|
1779
|
+
# {
|
|
1780
|
+
# items: [
|
|
1781
|
+
# {
|
|
1782
|
+
# arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/campaign/camp-5Hq2m8x4k1p9w",
|
|
1783
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
1784
|
+
# name: "Q4 GenAI Campaign",
|
|
1785
|
+
# start_on: "2026-11-01",
|
|
1786
|
+
# state: "ACTIVE",
|
|
1787
|
+
# },
|
|
1788
|
+
# ],
|
|
1789
|
+
# }
|
|
1790
|
+
#
|
|
1791
|
+
# @example Request syntax with placeholder values
|
|
1792
|
+
#
|
|
1793
|
+
# resp = client.list_campaigns({
|
|
1794
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1795
|
+
# campaign_identifiers: ["CampaignIdentifier"],
|
|
1796
|
+
# name: "CampaignName",
|
|
1797
|
+
# states: ["DRAFT"], # accepts DRAFT, ACTIVE, COMPLETED
|
|
1798
|
+
# sort: {
|
|
1799
|
+
# sort_by: "NAME", # required, accepts NAME, STATE, START_ON, CREATED_AT
|
|
1800
|
+
# sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
|
|
1801
|
+
# },
|
|
1802
|
+
# max_results: 1,
|
|
1803
|
+
# next_token: "NextToken",
|
|
1804
|
+
# })
|
|
1805
|
+
#
|
|
1806
|
+
# @example Response structure
|
|
1807
|
+
#
|
|
1808
|
+
# resp.items #=> Array
|
|
1809
|
+
# resp.items[0].campaign_id #=> String
|
|
1810
|
+
# resp.items[0].arn #=> String
|
|
1811
|
+
# resp.items[0].name #=> String
|
|
1812
|
+
# resp.items[0].state #=> String, one of "DRAFT", "ACTIVE", "COMPLETED"
|
|
1813
|
+
# resp.items[0].language #=> String, one of "en", "es", "es-419", "fr", "de", "it", "pt-BR", "id", "tr", "ja", "ko", "zh-Hans", "zh-Hant", "ar"
|
|
1814
|
+
# resp.items[0].start_on #=> String
|
|
1815
|
+
# resp.items[0].end_on #=> String
|
|
1816
|
+
# resp.items[0].created_at #=> Time
|
|
1817
|
+
# resp.items[0].updated_at #=> Time
|
|
1818
|
+
# resp.next_token #=> String
|
|
1819
|
+
#
|
|
1820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaigns AWS API Documentation
|
|
1821
|
+
#
|
|
1822
|
+
# @overload list_campaigns(params = {})
|
|
1823
|
+
# @param [Hash] params ({})
|
|
1824
|
+
def list_campaigns(params = {}, options = {})
|
|
1825
|
+
req = build_request(:list_campaigns, params)
|
|
1826
|
+
req.send_request(options)
|
|
1827
|
+
end
|
|
1828
|
+
|
|
1829
|
+
# Lists the partner's social connections, optionally filtered by
|
|
1830
|
+
# platform.
|
|
1831
|
+
#
|
|
1832
|
+
# @option params [required, String] :catalog
|
|
1833
|
+
# Catalog to list connections from.
|
|
1834
|
+
#
|
|
1835
|
+
# @option params [String] :platform
|
|
1836
|
+
# Restrict results to a single social platform.
|
|
1837
|
+
#
|
|
1838
|
+
# @option params [Integer] :max_results
|
|
1839
|
+
# Maximum number of results to return per page.
|
|
1840
|
+
#
|
|
1841
|
+
# @option params [String] :next_token
|
|
1842
|
+
# Pagination token from a previous response.
|
|
1843
|
+
#
|
|
1844
|
+
# @return [Types::ListSocialConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1845
|
+
#
|
|
1846
|
+
# * {Types::ListSocialConnectionsResponse#items #items} => Array<Types::SocialConnectionSummary>
|
|
1847
|
+
# * {Types::ListSocialConnectionsResponse#next_token #next_token} => String
|
|
1848
|
+
#
|
|
1849
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1850
|
+
#
|
|
1851
|
+
# @example Request syntax with placeholder values
|
|
1852
|
+
#
|
|
1853
|
+
# resp = client.list_social_connections({
|
|
1854
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
1855
|
+
# platform: "FACEBOOK", # accepts FACEBOOK, LINKEDIN, X
|
|
1856
|
+
# max_results: 1,
|
|
1857
|
+
# next_token: "NextToken",
|
|
1858
|
+
# })
|
|
1859
|
+
#
|
|
1860
|
+
# @example Response structure
|
|
1861
|
+
#
|
|
1862
|
+
# resp.items #=> Array
|
|
1863
|
+
# resp.items[0].id #=> String
|
|
1864
|
+
# resp.items[0].platform #=> String, one of "FACEBOOK", "LINKEDIN", "X"
|
|
1865
|
+
# resp.items[0].status #=> String, one of "AUTHORIZED", "EXPIRED", "PAGE_REQUIRED"
|
|
1866
|
+
# resp.items[0].page_name #=> String
|
|
1867
|
+
# resp.items[0].account_name #=> String
|
|
1868
|
+
# resp.items[0].connected_at #=> Time
|
|
1869
|
+
# resp.items[0].expires_at #=> Time
|
|
1870
|
+
# resp.next_token #=> String
|
|
1871
|
+
#
|
|
1872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListSocialConnections AWS API Documentation
|
|
1873
|
+
#
|
|
1874
|
+
# @overload list_social_connections(params = {})
|
|
1875
|
+
# @param [Hash] params ({})
|
|
1876
|
+
def list_social_connections(params = {}, options = {})
|
|
1877
|
+
req = build_request(:list_social_connections, params)
|
|
1878
|
+
req.send_request(options)
|
|
1879
|
+
end
|
|
1880
|
+
|
|
1881
|
+
# Lists the tags applied to a Partner Central Marketing resource.
|
|
1882
|
+
#
|
|
1883
|
+
# @option params [required, String] :resource_arn
|
|
1884
|
+
# The ARN of the resource whose tags should be returned.
|
|
1885
|
+
#
|
|
1886
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1887
|
+
#
|
|
1888
|
+
# * {Types::ListTagsForResourceResponse#resource_arn #resource_arn} => String
|
|
1889
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
|
1890
|
+
#
|
|
1891
|
+
# @example Request syntax with placeholder values
|
|
1892
|
+
#
|
|
1893
|
+
# resp = client.list_tags_for_resource({
|
|
1894
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
1895
|
+
# })
|
|
1896
|
+
#
|
|
1897
|
+
# @example Response structure
|
|
1898
|
+
#
|
|
1899
|
+
# resp.resource_arn #=> String
|
|
1900
|
+
# resp.tags #=> Array
|
|
1901
|
+
# resp.tags[0].key #=> String
|
|
1902
|
+
# resp.tags[0].value #=> String
|
|
1903
|
+
#
|
|
1904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListTagsForResource AWS API Documentation
|
|
1905
|
+
#
|
|
1906
|
+
# @overload list_tags_for_resource(params = {})
|
|
1907
|
+
# @param [Hash] params ({})
|
|
1908
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
1909
|
+
req = build_request(:list_tags_for_resource, params)
|
|
1910
|
+
req.send_request(options)
|
|
1911
|
+
end
|
|
1912
|
+
|
|
1913
|
+
# Searches and browses the AWS-authored campaign template catalog. With
|
|
1914
|
+
# no SearchText it returns the whole catalog in the default order, so
|
|
1915
|
+
# browse and keyword search share one shape; GetCampaignTemplate reads
|
|
1916
|
+
# one template.
|
|
1917
|
+
#
|
|
1918
|
+
# @option params [required, String] :catalog
|
|
1919
|
+
# The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
|
|
1920
|
+
#
|
|
1921
|
+
# @option params [String] :search_text
|
|
1922
|
+
# Free-text query matched against the template's name and description.
|
|
1923
|
+
# Any word may match, and the last word matches as a prefix when it has
|
|
1924
|
+
# 3 or more characters, so `nov` finds Amazon Nova. A template whose
|
|
1925
|
+
# name holds the query as a phrase ranks first, then whole-word matches,
|
|
1926
|
+
# then prefix-only ones. Omit to browse the whole catalog. Text analysis
|
|
1927
|
+
# is derived from each template's own LanguageCode, never from the
|
|
1928
|
+
# language filter.
|
|
1929
|
+
#
|
|
1930
|
+
# @option params [Array<String>] :industry
|
|
1931
|
+
# Restrict to templates in these industries. Values within this member
|
|
1932
|
+
# are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive
|
|
1933
|
+
# match.
|
|
1934
|
+
#
|
|
1935
|
+
# @option params [Array<String>] :use_case
|
|
1936
|
+
# Restrict to templates with these campaign use cases. Values within
|
|
1937
|
+
# this member are OR-ed; distinct facet members are AND-ed. Exact,
|
|
1938
|
+
# case-sensitive match.
|
|
1939
|
+
#
|
|
1940
|
+
# @option params [Array<String>] :language
|
|
1941
|
+
# Restrict to templates in these language(s), matched by each
|
|
1942
|
+
# template's `LanguageCode`. Values within this member are OR-ed;
|
|
1943
|
+
# distinct facet members are AND-ed. Narrows results; it does not
|
|
1944
|
+
# reinterpret SearchText.
|
|
1945
|
+
#
|
|
1946
|
+
# @option params [Array<String>] :aws_services
|
|
1947
|
+
# Restrict to templates promoting these AWS services. Values within this
|
|
1948
|
+
# member are OR-ed; distinct facet members are AND-ed. Exact,
|
|
1949
|
+
# case-sensitive match.
|
|
1950
|
+
#
|
|
1951
|
+
# @option params [Array<String>] :customer_segments
|
|
1952
|
+
# Restrict to templates for these customer segments. Values within this
|
|
1953
|
+
# member are OR-ed; distinct facet members are AND-ed. A template that
|
|
1954
|
+
# names no customer segment matches every value.
|
|
1955
|
+
#
|
|
1956
|
+
# @option params [Array<String>] :themes
|
|
1957
|
+
# Restrict to templates with these themes. Values within this member are
|
|
1958
|
+
# OR-ed; distinct facet members are AND-ed. A template that names no
|
|
1959
|
+
# theme matches every value.
|
|
1960
|
+
#
|
|
1961
|
+
# @option params [Array<String>] :collection
|
|
1962
|
+
# Restrict to templates in these collections. Values within this member
|
|
1963
|
+
# are OR-ed; distinct facet members are AND-ed. Omit for no restriction;
|
|
1964
|
+
# there is no default.
|
|
1965
|
+
#
|
|
1966
|
+
# @option params [Integer] :max_results
|
|
1967
|
+
# Maximum results per page.
|
|
1968
|
+
#
|
|
1969
|
+
# @option params [String] :next_token
|
|
1970
|
+
# Pagination token.
|
|
1971
|
+
#
|
|
1972
|
+
# @return [Types::SearchCampaignTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1973
|
+
#
|
|
1974
|
+
# * {Types::SearchCampaignTemplatesResponse#total_results #total_results} => Integer
|
|
1975
|
+
# * {Types::SearchCampaignTemplatesResponse#campaign_templates #campaign_templates} => Array<Types::CampaignTemplateSummary>
|
|
1976
|
+
# * {Types::SearchCampaignTemplatesResponse#next_token #next_token} => String
|
|
1977
|
+
#
|
|
1978
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1979
|
+
#
|
|
1980
|
+
#
|
|
1981
|
+
# @example Example: Browse the whole catalog
|
|
1982
|
+
#
|
|
1983
|
+
# resp = client.search_campaign_templates({
|
|
1984
|
+
# catalog: "AWS",
|
|
1985
|
+
# })
|
|
1986
|
+
#
|
|
1987
|
+
# resp.to_h outputs the following:
|
|
1988
|
+
# {
|
|
1989
|
+
# campaign_templates: [
|
|
1990
|
+
# ],
|
|
1991
|
+
# total_results: 0,
|
|
1992
|
+
# }
|
|
1993
|
+
#
|
|
1994
|
+
# @example Example: Search with a facet filter
|
|
1995
|
+
#
|
|
1996
|
+
# resp = client.search_campaign_templates({
|
|
1997
|
+
# catalog: "AWS",
|
|
1998
|
+
# industry: [
|
|
1999
|
+
# "TELECOMMUNICATIONS",
|
|
2000
|
+
# ],
|
|
2001
|
+
# search_text: "contact center",
|
|
2002
|
+
# })
|
|
2003
|
+
#
|
|
2004
|
+
# resp.to_h outputs the following:
|
|
2005
|
+
# {
|
|
2006
|
+
# campaign_templates: [
|
|
2007
|
+
# ],
|
|
2008
|
+
# total_results: 0,
|
|
2009
|
+
# }
|
|
2010
|
+
#
|
|
2011
|
+
# @example Example: Browse the Build with AI collection in one language
|
|
2012
|
+
#
|
|
2013
|
+
# resp = client.search_campaign_templates({
|
|
2014
|
+
# catalog: "AWS",
|
|
2015
|
+
# collection: [
|
|
2016
|
+
# "BUILD_WITH_AI",
|
|
2017
|
+
# ],
|
|
2018
|
+
# language: [
|
|
2019
|
+
# "ja",
|
|
2020
|
+
# ],
|
|
2021
|
+
# })
|
|
2022
|
+
#
|
|
2023
|
+
# resp.to_h outputs the following:
|
|
2024
|
+
# {
|
|
2025
|
+
# campaign_templates: [
|
|
2026
|
+
# {
|
|
2027
|
+
# collection: "BUILD_WITH_AI",
|
|
2028
|
+
# id: "tmpl-z7icunek7m2x8",
|
|
2029
|
+
# language_code: "ja",
|
|
2030
|
+
# name: "Build with AI (Japanese)",
|
|
2031
|
+
# },
|
|
2032
|
+
# ],
|
|
2033
|
+
# total_results: 1,
|
|
2034
|
+
# }
|
|
2035
|
+
#
|
|
2036
|
+
# @example Request syntax with placeholder values
|
|
2037
|
+
#
|
|
2038
|
+
# resp = client.search_campaign_templates({
|
|
2039
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
2040
|
+
# search_text: "TemplateSearchText",
|
|
2041
|
+
# industry: ["FINANCIAL_SERVICES"], # accepts FINANCIAL_SERVICES, HEALTHCARE, MANUFACTURING, RETAIL, MEDIA_ENTERTAINMENT, ENERGY, EDUCATION, GOVERNMENT, TELECOMMUNICATIONS, AUTOMOTIVE, INSURANCE, OTHER
|
|
2042
|
+
# use_case: ["UseCaseFilter"],
|
|
2043
|
+
# language: ["en"], # accepts en, es, es-419, fr, de, it, pt-BR, id, tr, ja, ko, zh-Hans, zh-Hant, ar
|
|
2044
|
+
# aws_services: ["String"],
|
|
2045
|
+
# customer_segments: ["ENTERPRISE"], # accepts ENTERPRISE, SMB, PUBLIC_SECTOR, ISV
|
|
2046
|
+
# themes: ["AI"], # accepts AI, MIGRATION_MODERNIZATION, SECURITY, DATA_ANALYTICS, AWS_TRAINING_CERTIFICATION, AWS_MARKETPLACE, CONNECT, EVENTS
|
|
2047
|
+
# collection: ["GENERAL"], # accepts GENERAL, BUILD_WITH_AI
|
|
2048
|
+
# max_results: 1,
|
|
2049
|
+
# next_token: "NextToken",
|
|
2050
|
+
# })
|
|
2051
|
+
#
|
|
2052
|
+
# @example Response structure
|
|
2053
|
+
#
|
|
2054
|
+
# resp.total_results #=> Integer
|
|
2055
|
+
# resp.campaign_templates #=> Array
|
|
2056
|
+
# resp.campaign_templates[0].id #=> String
|
|
2057
|
+
# resp.campaign_templates[0].name #=> String
|
|
2058
|
+
# resp.campaign_templates[0].industry #=> String, one of "FINANCIAL_SERVICES", "HEALTHCARE", "MANUFACTURING", "RETAIL", "MEDIA_ENTERTAINMENT", "ENERGY", "EDUCATION", "GOVERNMENT", "TELECOMMUNICATIONS", "AUTOMOTIVE", "INSURANCE", "OTHER"
|
|
2059
|
+
# resp.campaign_templates[0].use_case #=> String
|
|
2060
|
+
# resp.campaign_templates[0].description #=> String
|
|
2061
|
+
# resp.campaign_templates[0].language_code #=> String, one of "en", "es", "es-419", "fr", "de", "it", "pt-BR", "id", "tr", "ja", "ko", "zh-Hans", "zh-Hant", "ar"
|
|
2062
|
+
# resp.campaign_templates[0].collection #=> String, one of "GENERAL", "BUILD_WITH_AI"
|
|
2063
|
+
# resp.campaign_templates[0].aws_services #=> Array
|
|
2064
|
+
# resp.campaign_templates[0].aws_services[0] #=> String
|
|
2065
|
+
# resp.campaign_templates[0].customer_segments #=> Array
|
|
2066
|
+
# resp.campaign_templates[0].customer_segments[0] #=> String, one of "ENTERPRISE", "SMB", "PUBLIC_SECTOR", "ISV"
|
|
2067
|
+
# resp.campaign_templates[0].themes #=> Array
|
|
2068
|
+
# resp.campaign_templates[0].themes[0] #=> String, one of "AI", "MIGRATION_MODERNIZATION", "SECURITY", "DATA_ANALYTICS", "AWS_TRAINING_CERTIFICATION", "AWS_MARKETPLACE", "CONNECT", "EVENTS"
|
|
2069
|
+
# resp.campaign_templates[0].thumbnail_url #=> String
|
|
2070
|
+
# resp.next_token #=> String
|
|
2071
|
+
#
|
|
2072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/SearchCampaignTemplates AWS API Documentation
|
|
2073
|
+
#
|
|
2074
|
+
# @overload search_campaign_templates(params = {})
|
|
2075
|
+
# @param [Hash] params ({})
|
|
2076
|
+
def search_campaign_templates(params = {}, options = {})
|
|
2077
|
+
req = build_request(:search_campaign_templates, params)
|
|
2078
|
+
req.send_request(options)
|
|
2079
|
+
end
|
|
2080
|
+
|
|
2081
|
+
# Activates 1–25 of a campaign's assets as one ordered unit, and
|
|
2082
|
+
# returns a task to poll.
|
|
2083
|
+
#
|
|
2084
|
+
# Takes a **list** because the service owns the ordering. Assets link to
|
|
2085
|
+
# one another by URL — an email's call-to-action carries the landing
|
|
2086
|
+
# page's URL, the landing page's download field carries the
|
|
2087
|
+
# document's — and a URL does not exist until the asset it points at is
|
|
2088
|
+
# activated. Those edges are derived by the service from the campaign's
|
|
2089
|
+
# pinned template, so reconstructing and topologically sorting them is
|
|
2090
|
+
# work the service has already done, and getting it wrong arms an email
|
|
2091
|
+
# with a dead link. Name every asset you want live and the service
|
|
2092
|
+
# sequences them; "activate everything" is the list with every id in it,
|
|
2093
|
+
# which ListCampaignAssets already gave you.
|
|
2094
|
+
#
|
|
2095
|
+
# Asynchronous, because activating an asset installs or arms behaviour
|
|
2096
|
+
# that runs later and an email activation bulk-loads its audience into
|
|
2097
|
+
# the delivery platform. Everything decidable **without** a write to the
|
|
2098
|
+
# delivery platform is evaluated before this returns; everything else
|
|
2099
|
+
# lands on the task.
|
|
2100
|
+
#
|
|
2101
|
+
# A refusal that applies to one asset does not fail the request: that
|
|
2102
|
+
# asset is on the task already FAILED, with its reason, and the rest
|
|
2103
|
+
# run. A refusal that applies to the whole request — a malformed list,
|
|
2104
|
+
# an unknown campaign, another task already running on this campaign,
|
|
2105
|
+
# this service's service-linked role being deleted (ConflictException
|
|
2106
|
+
# `SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS`), a campaign setting an
|
|
2107
|
+
# asset in the request needs (ValidationException
|
|
2108
|
+
# `CAMPAIGN_INCOMPLETE`), a campaign sender that no longer passes
|
|
2109
|
+
# `CreateCampaign`'s sender rules while the request names an email
|
|
2110
|
+
# (ValidationException with no `FieldList`, whose message ends with one
|
|
2111
|
+
# `Reason: <code>` token per failed rule: `PATTERN_MISMATCH`,
|
|
2112
|
+
# `SENDER_DOMAIN_NOT_ALLIANCE_LEAD`, or `SENDER_DOMAIN_DKIM_MISSING`
|
|
2113
|
+
# and/or `SENDER_DOMAIN_DMARC_MISSING`) — is thrown, and nothing starts.
|
|
2114
|
+
#
|
|
2115
|
+
# One task runs on a campaign at a time. A second concurrent call is
|
|
2116
|
+
# refused with ConflictException / CAMPAIGN\_ACTIVATION\_IN\_PROGRESS,
|
|
2117
|
+
# whose `ResourceId` names the task already holding the campaign. Two
|
|
2118
|
+
# tasks over *disjoint* asset sets are refused too: the guard is
|
|
2119
|
+
# deliberately campaign-wide, because overlapping runs made the
|
|
2120
|
+
# per-asset status misleading rather than merely contended.
|
|
2121
|
+
#
|
|
2122
|
+
# @option params [required, String] :catalog
|
|
2123
|
+
# The catalog (AWS or Sandbox).
|
|
2124
|
+
#
|
|
2125
|
+
# @option params [required, String] :campaign_identifier
|
|
2126
|
+
# The campaign identifier, which also authorizes the call.
|
|
2127
|
+
#
|
|
2128
|
+
# @option params [required, Array<String>] :campaign_asset_identifiers
|
|
2129
|
+
# The assets to activate, in any order — the service derives the
|
|
2130
|
+
# dependency order and ignores the order given here.
|
|
2131
|
+
#
|
|
2132
|
+
# @option params [String] :client_token
|
|
2133
|
+
# Idempotency token. Two requests carrying the same token are one
|
|
2134
|
+
# request, and the second returns the first one's task rather than
|
|
2135
|
+
# starting a second.
|
|
2136
|
+
#
|
|
2137
|
+
# The deduplication window is the **life of the task record**, not a
|
|
2138
|
+
# fixed number of hours: replaying a token after the task has expired
|
|
2139
|
+
# starts a new task. Stated because a caller would otherwise assume the
|
|
2140
|
+
# usual few-hour guarantee.
|
|
2141
|
+
#
|
|
2142
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2143
|
+
# not need to pass this option.**
|
|
2144
|
+
#
|
|
2145
|
+
# @return [Types::StartCampaignAssetActivationTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2146
|
+
#
|
|
2147
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#campaign_id #campaign_id} => String
|
|
2148
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#task_id #task_id} => String
|
|
2149
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#task_status #task_status} => String
|
|
2150
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#started_at #started_at} => Time
|
|
2151
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#ended_at #ended_at} => Time
|
|
2152
|
+
# * {Types::StartCampaignAssetActivationTaskResponse#assets #assets} => Array<Types::CampaignAssetActivationOutcome>
|
|
2153
|
+
#
|
|
2154
|
+
#
|
|
2155
|
+
# @example Example: Activate a whole campaign kit
|
|
2156
|
+
#
|
|
2157
|
+
# resp = client.start_campaign_asset_activation_task({
|
|
2158
|
+
# campaign_asset_identifiers: [
|
|
2159
|
+
# "ast-4b81e0c9f2a7b",
|
|
2160
|
+
# "ast-9f3c1a2b7d40e",
|
|
2161
|
+
# "ast-2k7m4p9x1c6qd",
|
|
2162
|
+
# "ast-7w3n8r5t2h1ya",
|
|
2163
|
+
# ],
|
|
2164
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2165
|
+
# catalog: "AWS",
|
|
2166
|
+
# })
|
|
2167
|
+
#
|
|
2168
|
+
# resp.to_h outputs the following:
|
|
2169
|
+
# {
|
|
2170
|
+
# assets: [
|
|
2171
|
+
# {
|
|
2172
|
+
# campaign_asset_id: "ast-4b81e0c9f2a7b",
|
|
2173
|
+
# status: "IN_PROGRESS",
|
|
2174
|
+
# },
|
|
2175
|
+
# {
|
|
2176
|
+
# campaign_asset_id: "ast-9f3c1a2b7d40e",
|
|
2177
|
+
# status: "IN_PROGRESS",
|
|
2178
|
+
# },
|
|
2179
|
+
# {
|
|
2180
|
+
# campaign_asset_id: "ast-2k7m4p9x1c6qd",
|
|
2181
|
+
# status: "IN_PROGRESS",
|
|
2182
|
+
# },
|
|
2183
|
+
# {
|
|
2184
|
+
# campaign_asset_id: "ast-7w3n8r5t2h1ya",
|
|
2185
|
+
# status: "IN_PROGRESS",
|
|
2186
|
+
# },
|
|
2187
|
+
# ],
|
|
2188
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
2189
|
+
# started_at: Time.parse(1764547200),
|
|
2190
|
+
# task_id: "atsk-7k2M9x4qp1w8n",
|
|
2191
|
+
# task_status: "IN_PROGRESS",
|
|
2192
|
+
# }
|
|
2193
|
+
#
|
|
2194
|
+
# @example Example: Some assets refused, the rest started anyway
|
|
2195
|
+
#
|
|
2196
|
+
# resp = client.start_campaign_asset_activation_task({
|
|
2197
|
+
# campaign_asset_identifiers: [
|
|
2198
|
+
# "ast-4b81e0c9f2a7b",
|
|
2199
|
+
# "ast-9f3c1a2b7d40e",
|
|
2200
|
+
# "ast-2k7m4p9x1c6qd",
|
|
2201
|
+
# "ast-7w3n8r5t2h1ya",
|
|
2202
|
+
# ],
|
|
2203
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2204
|
+
# catalog: "AWS",
|
|
2205
|
+
# })
|
|
2206
|
+
#
|
|
2207
|
+
# resp.to_h outputs the following:
|
|
2208
|
+
# {
|
|
2209
|
+
# assets: [
|
|
2210
|
+
# {
|
|
2211
|
+
# campaign_asset_id: "ast-4b81e0c9f2a7b",
|
|
2212
|
+
# message: "An asset this one embeds is not live.",
|
|
2213
|
+
# reason: "PREREQUISITE_ASSET_NOT_ACTIVE",
|
|
2214
|
+
# status: "FAILED",
|
|
2215
|
+
# },
|
|
2216
|
+
# {
|
|
2217
|
+
# campaign_asset_id: "ast-9f3c1a2b7d40e",
|
|
2218
|
+
# message: "An asset this one embeds is not live.",
|
|
2219
|
+
# reason: "PREREQUISITE_ASSET_NOT_ACTIVE",
|
|
2220
|
+
# status: "FAILED",
|
|
2221
|
+
# },
|
|
2222
|
+
# {
|
|
2223
|
+
# campaign_asset_id: "ast-2k7m4p9x1c6qd",
|
|
2224
|
+
# message: "Required fields are empty.",
|
|
2225
|
+
# reason: "REQUIRED_FIELD_MISSING",
|
|
2226
|
+
# status: "FAILED",
|
|
2227
|
+
# },
|
|
2228
|
+
# {
|
|
2229
|
+
# campaign_asset_id: "ast-7w3n8r5t2h1ya",
|
|
2230
|
+
# status: "IN_PROGRESS",
|
|
2231
|
+
# },
|
|
2232
|
+
# ],
|
|
2233
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
2234
|
+
# started_at: Time.parse(1764547200),
|
|
2235
|
+
# task_id: "atsk-3n7V2h5r9t4kc",
|
|
2236
|
+
# task_status: "IN_PROGRESS",
|
|
2237
|
+
# }
|
|
2238
|
+
#
|
|
2239
|
+
# @example Example: Every asset refused, so the task is FAILED at once
|
|
2240
|
+
#
|
|
2241
|
+
# resp = client.start_campaign_asset_activation_task({
|
|
2242
|
+
# campaign_asset_identifiers: [
|
|
2243
|
+
# "ast-2k7m4p9x1c6qd",
|
|
2244
|
+
# ],
|
|
2245
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2246
|
+
# catalog: "AWS",
|
|
2247
|
+
# })
|
|
2248
|
+
#
|
|
2249
|
+
# resp.to_h outputs the following:
|
|
2250
|
+
# {
|
|
2251
|
+
# assets: [
|
|
2252
|
+
# {
|
|
2253
|
+
# campaign_asset_id: "ast-2k7m4p9x1c6qd",
|
|
2254
|
+
# message: "This kind of asset is downloaded rather than published.",
|
|
2255
|
+
# reason: "ASSET_NOT_STARTABLE",
|
|
2256
|
+
# status: "FAILED",
|
|
2257
|
+
# },
|
|
2258
|
+
# ],
|
|
2259
|
+
# campaign_id: "camp-5Hq2m8x4k1p9w",
|
|
2260
|
+
# ended_at: Time.parse(1764547200),
|
|
2261
|
+
# started_at: Time.parse(1764547200),
|
|
2262
|
+
# task_id: "atsk-9p4W2k7m3x8qa",
|
|
2263
|
+
# task_status: "FAILED",
|
|
2264
|
+
# }
|
|
2265
|
+
#
|
|
2266
|
+
# @example Request syntax with placeholder values
|
|
2267
|
+
#
|
|
2268
|
+
# resp = client.start_campaign_asset_activation_task({
|
|
2269
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
2270
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
2271
|
+
# campaign_asset_identifiers: ["CampaignAssetId"], # required
|
|
2272
|
+
# client_token: "ClientToken",
|
|
2273
|
+
# })
|
|
2274
|
+
#
|
|
2275
|
+
# @example Response structure
|
|
2276
|
+
#
|
|
2277
|
+
# resp.campaign_id #=> String
|
|
2278
|
+
# resp.task_id #=> String
|
|
2279
|
+
# resp.task_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "PARTIAL_FAILURE", "FAILED"
|
|
2280
|
+
# resp.started_at #=> Time
|
|
2281
|
+
# resp.ended_at #=> Time
|
|
2282
|
+
# resp.assets #=> Array
|
|
2283
|
+
# resp.assets[0].campaign_asset_id #=> String
|
|
2284
|
+
# resp.assets[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
2285
|
+
# resp.assets[0].reason #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
2286
|
+
# resp.assets[0].message #=> String
|
|
2287
|
+
#
|
|
2288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetActivationTask AWS API Documentation
|
|
2289
|
+
#
|
|
2290
|
+
# @overload start_campaign_asset_activation_task(params = {})
|
|
2291
|
+
# @param [Hash] params ({})
|
|
2292
|
+
def start_campaign_asset_activation_task(params = {}, options = {})
|
|
2293
|
+
req = build_request(:start_campaign_asset_activation_task, params)
|
|
2294
|
+
req.send_request(options)
|
|
2295
|
+
end
|
|
2296
|
+
|
|
2297
|
+
# Starts an asynchronous task that packages a campaign's assets into a
|
|
2298
|
+
# single downloadable ZIP archive.
|
|
2299
|
+
#
|
|
2300
|
+
# Fire-and-return: the campaign is validated (it must exist and not be
|
|
2301
|
+
# cancelled), a task record is persisted, an asynchronous execution is
|
|
2302
|
+
# started, and the task id is returned with status IN\_PROGRESS. This
|
|
2303
|
+
# operation does not inspect assets — all resolution, exclusion, and
|
|
2304
|
+
# failure are determined by the execution and surfaced only by
|
|
2305
|
+
# GetCampaignAssetExportTask.
|
|
2306
|
+
#
|
|
2307
|
+
# Every campaign is exportable, including one never activated, because
|
|
2308
|
+
# renderable assets are composed on demand at export time rather than
|
|
2309
|
+
# requiring finished, launched deliverables.
|
|
2310
|
+
#
|
|
2311
|
+
# @option params [required, String] :catalog
|
|
2312
|
+
# The catalog (AWS or Sandbox).
|
|
2313
|
+
#
|
|
2314
|
+
# @option params [required, String] :campaign_identifier
|
|
2315
|
+
# The campaign whose assets are exported. Accepts the campaign id or
|
|
2316
|
+
# ARN.
|
|
2317
|
+
#
|
|
2318
|
+
# @option params [String] :client_token
|
|
2319
|
+
# Idempotency token. Two requests carrying the same token within the
|
|
2320
|
+
# dedup window are one request and return the same task id.
|
|
2321
|
+
#
|
|
2322
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2323
|
+
# not need to pass this option.**
|
|
2324
|
+
#
|
|
2325
|
+
# @return [Types::StartCampaignAssetExportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2326
|
+
#
|
|
2327
|
+
# * {Types::StartCampaignAssetExportTaskResponse#id #id} => String
|
|
2328
|
+
# * {Types::StartCampaignAssetExportTaskResponse#status #status} => String
|
|
2329
|
+
#
|
|
2330
|
+
# @example Request syntax with placeholder values
|
|
2331
|
+
#
|
|
2332
|
+
# resp = client.start_campaign_asset_export_task({
|
|
2333
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
2334
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
2335
|
+
# client_token: "ClientToken",
|
|
2336
|
+
# })
|
|
2337
|
+
#
|
|
2338
|
+
# @example Response structure
|
|
2339
|
+
#
|
|
2340
|
+
# resp.id #=> String
|
|
2341
|
+
# resp.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
|
2342
|
+
#
|
|
2343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetExportTask AWS API Documentation
|
|
2344
|
+
#
|
|
2345
|
+
# @overload start_campaign_asset_export_task(params = {})
|
|
2346
|
+
# @param [Hash] params ({})
|
|
2347
|
+
def start_campaign_asset_export_task(params = {}, options = {})
|
|
2348
|
+
req = build_request(:start_campaign_asset_export_task, params)
|
|
2349
|
+
req.send_request(options)
|
|
2350
|
+
end
|
|
2351
|
+
|
|
2352
|
+
# Adds or replaces tags on a Partner Central Marketing resource.
|
|
2353
|
+
#
|
|
2354
|
+
# Idempotent: applying a tag that is already present with the same value
|
|
2355
|
+
# is a no-op, and supplying a key that already exists replaces its
|
|
2356
|
+
# value.
|
|
2357
|
+
#
|
|
2358
|
+
# @option params [required, String] :resource_arn
|
|
2359
|
+
# The ARN of the resource to tag.
|
|
2360
|
+
#
|
|
2361
|
+
# @option params [required, Array<Types::Tag>] :tags
|
|
2362
|
+
# The tags to add or replace.
|
|
2363
|
+
#
|
|
2364
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2365
|
+
#
|
|
2366
|
+
# @example Request syntax with placeholder values
|
|
2367
|
+
#
|
|
2368
|
+
# resp = client.tag_resource({
|
|
2369
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
2370
|
+
# tags: [ # required
|
|
2371
|
+
# {
|
|
2372
|
+
# key: "TagKey", # required
|
|
2373
|
+
# value: "TagValue", # required
|
|
2374
|
+
# },
|
|
2375
|
+
# ],
|
|
2376
|
+
# })
|
|
2377
|
+
#
|
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TagResource AWS API Documentation
|
|
2379
|
+
#
|
|
2380
|
+
# @overload tag_resource(params = {})
|
|
2381
|
+
# @param [Hash] params ({})
|
|
2382
|
+
def tag_resource(params = {}, options = {})
|
|
2383
|
+
req = build_request(:tag_resource, params)
|
|
2384
|
+
req.send_request(options)
|
|
2385
|
+
end
|
|
2386
|
+
|
|
2387
|
+
# Removes tags from a Partner Central Marketing resource.
|
|
2388
|
+
#
|
|
2389
|
+
# Idempotent: removing a key that is not present succeeds.
|
|
2390
|
+
#
|
|
2391
|
+
# @option params [required, String] :resource_arn
|
|
2392
|
+
# The ARN of the resource to remove tags from.
|
|
2393
|
+
#
|
|
2394
|
+
# @option params [required, Array<String>] :tag_keys
|
|
2395
|
+
# The tag keys to remove. Associated values are removed with them.
|
|
2396
|
+
#
|
|
2397
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2398
|
+
#
|
|
2399
|
+
# @example Request syntax with placeholder values
|
|
2400
|
+
#
|
|
2401
|
+
# resp = client.untag_resource({
|
|
2402
|
+
# resource_arn: "TaggableResourceArn", # required
|
|
2403
|
+
# tag_keys: ["TagKey"], # required
|
|
2404
|
+
# })
|
|
2405
|
+
#
|
|
2406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UntagResource AWS API Documentation
|
|
2407
|
+
#
|
|
2408
|
+
# @overload untag_resource(params = {})
|
|
2409
|
+
# @param [Hash] params ({})
|
|
2410
|
+
def untag_resource(params = {}, options = {})
|
|
2411
|
+
req = build_request(:untag_resource, params)
|
|
2412
|
+
req.send_request(options)
|
|
2413
|
+
end
|
|
2414
|
+
|
|
2415
|
+
# Edits a campaign in place.
|
|
2416
|
+
#
|
|
2417
|
+
# Partial update: an omitted field is left unchanged, which is the
|
|
2418
|
+
# standard meaning of an `Update` verb — a full replacement would be a
|
|
2419
|
+
# `Put`. Change-only, with no way to clear a field back to empty,
|
|
2420
|
+
# because the campaign's file members cannot round-trip: they are
|
|
2421
|
+
# written as an `s3://` reference and read back as a URL or as metadata,
|
|
2422
|
+
# so a replacement payload could not resend an unchanged recipient list
|
|
2423
|
+
# without re-uploading it.
|
|
2424
|
+
#
|
|
2425
|
+
# Refused while an activation task runs
|
|
2426
|
+
# (`CAMPAIGN_ACTIVATION_IN_PROGRESS`) and once the campaign is completed
|
|
2427
|
+
# (`CAMPAIGN_COMPLETED`, the UTC date is after its `EndOn`).
|
|
2428
|
+
#
|
|
2429
|
+
# Last-writer-wins, with no concurrency token: this is low-contention
|
|
2430
|
+
# metadata owned by one partner.
|
|
2431
|
+
#
|
|
2432
|
+
# @option params [required, String] :catalog
|
|
2433
|
+
# The catalog (AWS or Sandbox).
|
|
2434
|
+
#
|
|
2435
|
+
# @option params [required, String] :campaign_identifier
|
|
2436
|
+
# The campaign identifier.
|
|
2437
|
+
#
|
|
2438
|
+
# @option params [String] :name
|
|
2439
|
+
# The display name.
|
|
2440
|
+
#
|
|
2441
|
+
# @option params [String] :sender_email
|
|
2442
|
+
# Sets or replaces the address the campaign's emails are sent from.
|
|
2443
|
+
# Checked by the same three rules as on `CreateCampaign`, with the same
|
|
2444
|
+
# codes, but only when it differs, ignoring case, from the stored
|
|
2445
|
+
# sender: re-sending the stored one is not checked, and
|
|
2446
|
+
# `StartCampaignAssetActivationTask` re-checks it before an email
|
|
2447
|
+
# activates.
|
|
2448
|
+
#
|
|
2449
|
+
# Replaces, never clears: like every member of this operation, an
|
|
2450
|
+
# omitted value leaves the sender as it was, and there is no way to
|
|
2451
|
+
# remove one once set.
|
|
2452
|
+
#
|
|
2453
|
+
# @option params [String] :privacy_policy_url
|
|
2454
|
+
# Sets or replaces the URL of the partner's privacy policy. Replaces,
|
|
2455
|
+
# never clears.
|
|
2456
|
+
#
|
|
2457
|
+
# @option params [String] :partner_address
|
|
2458
|
+
# Sets or replaces the partner's postal address. Replaces, never
|
|
2459
|
+
# clears.
|
|
2460
|
+
#
|
|
2461
|
+
# @option params [Types::FileRef] :partner_badge
|
|
2462
|
+
# Sets or replaces the partner's badge, checked exactly as on
|
|
2463
|
+
# `CreateCampaign`. Replaces, never clears: upload the Standalone AWS
|
|
2464
|
+
# Partner badge to show it again. The badge an asset already published
|
|
2465
|
+
# keeps showing on it until that asset is activated again.
|
|
2466
|
+
#
|
|
2467
|
+
# @option params [Types::FileRef] :email_target
|
|
2468
|
+
# Replaces the campaign's attached recipient list.
|
|
2469
|
+
#
|
|
2470
|
+
# The referenced object is copied and pinned again on every call that
|
|
2471
|
+
# supplies it, so the pinned copy always reflects the *last*
|
|
2472
|
+
# `UpdateCampaign` that named one. Editing the source object in your
|
|
2473
|
+
# own bucket without calling this operation again has no effect.
|
|
2474
|
+
# Replaces, never detaches: a partner can swap the list but cannot
|
|
2475
|
+
# remove it.
|
|
2476
|
+
#
|
|
2477
|
+
# @option params [Array<String>] :email_target_engagement_group_ids
|
|
2478
|
+
# Engagement groups whose contacts the campaign's emails will also go
|
|
2479
|
+
# to (see `CreateCampaign`). Replaces the stored list; never clears it.
|
|
2480
|
+
#
|
|
2481
|
+
# As on `CreateCampaign`: each group once (`INVALID\_VALUE`
|
|
2482
|
+
# otherwise), not checked against your groups when saved, and resolved
|
|
2483
|
+
# at Start where the stage can (`ENGAGEMENT\_GROUPS\_UNAVAILABLE`
|
|
2484
|
+
# where it can't).
|
|
2485
|
+
#
|
|
2486
|
+
# @option params [Hash<String,Array>] :social_connections
|
|
2487
|
+
# Sets the account the campaign's social posts publish from, per
|
|
2488
|
+
# platform. Each platform named replaces that platform's choice; a
|
|
2489
|
+
# platform not named keeps its own. Replaces, never clears.
|
|
2490
|
+
#
|
|
2491
|
+
# Not checked against your connections here: a connection can be deleted
|
|
2492
|
+
# at any time, so the activation checks the choice. See
|
|
2493
|
+
# `Campaign$SocialConnections`.
|
|
2494
|
+
#
|
|
2495
|
+
# @option params [Types::MonetaryValue] :estimated_budget
|
|
2496
|
+
# What the partner expects the campaign to cost.
|
|
2497
|
+
#
|
|
2498
|
+
# @option params [Types::MonetaryValue] :total_budget
|
|
2499
|
+
# The campaign's total budget.
|
|
2500
|
+
#
|
|
2501
|
+
# @option params [Types::TargetAudience] :target_audience
|
|
2502
|
+
# Target audience configuration.
|
|
2503
|
+
#
|
|
2504
|
+
# @option params [String] :client_token
|
|
2505
|
+
# Idempotency token. Accepted and not stored: this is a change-only
|
|
2506
|
+
# partial update with last-writer-wins, so re-applying the same call
|
|
2507
|
+
# produces the same result and the same response. There is nothing a
|
|
2508
|
+
# replay cache would protect.
|
|
2509
|
+
#
|
|
2510
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2511
|
+
# not need to pass this option.**
|
|
2512
|
+
#
|
|
2513
|
+
# @option params [String] :start_on
|
|
2514
|
+
# The first day of the campaign's run window. Not after `EndOn`
|
|
2515
|
+
# (`ValidationException`, `INVALID_VALUE`).
|
|
2516
|
+
#
|
|
2517
|
+
# @option params [String] :end_on
|
|
2518
|
+
# The last day of the campaign's run window, inclusive and in UTC.
|
|
2519
|
+
#
|
|
2520
|
+
# Editable only while the campaign is open, like everything else here:
|
|
2521
|
+
# once the stored `EndOn` has passed the campaign is completed and this
|
|
2522
|
+
# update is refused (`CAMPAIGN_COMPLETED`). Refused with
|
|
2523
|
+
# `ValidationException` (`INVALID_VALUE`) when it is in the past, or
|
|
2524
|
+
# earlier than the day of a scheduled send on one of the campaign's
|
|
2525
|
+
# assets: move or cancel that send first. Setting it to today ends the
|
|
2526
|
+
# campaign at the next UTC midnight.
|
|
2527
|
+
#
|
|
2528
|
+
# @return [Types::UpdateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2529
|
+
#
|
|
2530
|
+
# * {Types::UpdateCampaignResponse#id #id} => String
|
|
2531
|
+
#
|
|
2532
|
+
#
|
|
2533
|
+
# @example Example: Rename a campaign and raise its budget
|
|
2534
|
+
#
|
|
2535
|
+
# resp = client.update_campaign({
|
|
2536
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2537
|
+
# catalog: "AWS",
|
|
2538
|
+
# name: "Q4 GenAI Campaign (EMEA)",
|
|
2539
|
+
# total_budget: {
|
|
2540
|
+
# amount: "40000.00",
|
|
2541
|
+
# currency_code: "USD",
|
|
2542
|
+
# },
|
|
2543
|
+
# })
|
|
2544
|
+
#
|
|
2545
|
+
# resp.to_h outputs the following:
|
|
2546
|
+
# {
|
|
2547
|
+
# id: "camp-5Hq2m8x4k1p9w",
|
|
2548
|
+
# }
|
|
2549
|
+
#
|
|
2550
|
+
# @example Request syntax with placeholder values
|
|
2551
|
+
#
|
|
2552
|
+
# resp = client.update_campaign({
|
|
2553
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
2554
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
2555
|
+
# name: "CampaignName",
|
|
2556
|
+
# sender_email: "SenderEmail",
|
|
2557
|
+
# privacy_policy_url: "PrivacyPolicyUrl",
|
|
2558
|
+
# partner_address: "PartnerAddress",
|
|
2559
|
+
# partner_badge: {
|
|
2560
|
+
# s3_uri: "S3Uri", # required
|
|
2561
|
+
# version_id: "S3VersionId", # required
|
|
2562
|
+
# },
|
|
2563
|
+
# email_target: {
|
|
2564
|
+
# s3_uri: "S3Uri", # required
|
|
2565
|
+
# version_id: "S3VersionId", # required
|
|
2566
|
+
# },
|
|
2567
|
+
# email_target_engagement_group_ids: ["EngagementGroupId"],
|
|
2568
|
+
# social_connections: {
|
|
2569
|
+
# "FACEBOOK" => ["SocialConnectionId"],
|
|
2570
|
+
# },
|
|
2571
|
+
# estimated_budget: {
|
|
2572
|
+
# amount: "Amount", # required
|
|
2573
|
+
# currency_code: "CurrencyCode", # required
|
|
2574
|
+
# },
|
|
2575
|
+
# total_budget: {
|
|
2576
|
+
# amount: "Amount", # required
|
|
2577
|
+
# currency_code: "CurrencyCode", # required
|
|
2578
|
+
# },
|
|
2579
|
+
# target_audience: {
|
|
2580
|
+
# industries: ["FINANCIAL_SERVICES"], # accepts FINANCIAL_SERVICES, HEALTHCARE, MANUFACTURING, RETAIL, MEDIA_ENTERTAINMENT, ENERGY, EDUCATION, GOVERNMENT, TELECOMMUNICATIONS, AUTOMOTIVE, INSURANCE, OTHER
|
|
2581
|
+
# company_sizes: ["STARTUP"], # accepts STARTUP, SMALL_BUSINESS, MID_MARKET, ENTERPRISE, GLOBAL_ENTERPRISE
|
|
2582
|
+
# countries: ["CountryCode"],
|
|
2583
|
+
# },
|
|
2584
|
+
# client_token: "ClientToken",
|
|
2585
|
+
# start_on: "UtcDate",
|
|
2586
|
+
# end_on: "UtcDate",
|
|
2587
|
+
# })
|
|
2588
|
+
#
|
|
2589
|
+
# @example Response structure
|
|
2590
|
+
#
|
|
2591
|
+
# resp.id #=> String
|
|
2592
|
+
#
|
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaign AWS API Documentation
|
|
2594
|
+
#
|
|
2595
|
+
# @overload update_campaign(params = {})
|
|
2596
|
+
# @param [Hash] params ({})
|
|
2597
|
+
def update_campaign(params = {}, options = {})
|
|
2598
|
+
req = build_request(:update_campaign, params)
|
|
2599
|
+
req.send_request(options)
|
|
2600
|
+
end
|
|
2601
|
+
|
|
2602
|
+
# Updates an asset's field values, layout or send time. Refused with
|
|
2603
|
+
# `ConflictException` while the campaign's running activation task
|
|
2604
|
+
# still owns the asset (`ASSET_START_IN_PROGRESS`), and for a live email
|
|
2605
|
+
# or social post (`ASSET_ALREADY_ACTIVE`): deactivate it first.
|
|
2606
|
+
#
|
|
2607
|
+
# @option params [required, String] :catalog
|
|
2608
|
+
# The catalog (AWS or Sandbox).
|
|
2609
|
+
#
|
|
2610
|
+
# @option params [required, String] :campaign_identifier
|
|
2611
|
+
# The campaign identifier.
|
|
2612
|
+
#
|
|
2613
|
+
# @option params [required, String] :campaign_asset_identifier
|
|
2614
|
+
# The asset identifier.
|
|
2615
|
+
#
|
|
2616
|
+
# @option params [Array<Types::FieldValueInput>] :field_values
|
|
2617
|
+
# Value-only updates to the asset's pinned template fields, keyed by
|
|
2618
|
+
# FieldId. The field schema (labels, descriptions, constraints,
|
|
2619
|
+
# placeholders, image defaults) is service-owned and pinned at
|
|
2620
|
+
# instantiation, so clients send only the values they are changing.
|
|
2621
|
+
# Fields omitted keep their stored values; send the entry with `Value`
|
|
2622
|
+
# omitted to clear one.
|
|
2623
|
+
#
|
|
2624
|
+
# Named `FieldValues` to match the member it edits on `CampaignAsset`,
|
|
2625
|
+
# which is the same concept read back. It was `templateFieldUpdates`;
|
|
2626
|
+
# the two names for one concept were the defect, not the length.
|
|
2627
|
+
#
|
|
2628
|
+
# @option params [String] :layout
|
|
2629
|
+
# Selects a multi-layout asset's layout: one of the values in
|
|
2630
|
+
# `CampaignAsset.layout.options`.
|
|
2631
|
+
#
|
|
2632
|
+
# PATCH: omitted leaves the selection unchanged, and there is no way to
|
|
2633
|
+
# clear it. A value that is not one of the asset's options — or any
|
|
2634
|
+
# value on a single-layout asset — is a plain `ValidationException`, and
|
|
2635
|
+
# nothing in the call is applied. Every pinned field stays writable
|
|
2636
|
+
# whichever layout is selected.
|
|
2637
|
+
#
|
|
2638
|
+
# @option params [String] :send_mode
|
|
2639
|
+
# When a **sendable** asset (`EMAIL`, `SOCIAL_POST`) sends: on
|
|
2640
|
+
# activation, or at `ScheduledSendAt`.
|
|
2641
|
+
#
|
|
2642
|
+
# A mode beside a value rather than a union, on purpose:
|
|
2643
|
+
# `ScheduledSendAt` stays a plain `Timestamp`, and the precedent is
|
|
2644
|
+
# EventBridge Scheduler's `FlexibleTimeWindow { Mode,
|
|
2645
|
+
# MaximumWindowInMinutes }`. The pair is checked as one, and a request
|
|
2646
|
+
# where they disagree is refused with `ValidationException`
|
|
2647
|
+
# (`INVALID_VALUE`, naming the member) and applies nothing:
|
|
2648
|
+
#
|
|
2649
|
+
# * `SCHEDULED` requires `ScheduledSendAt`; a reschedule resends
|
|
2650
|
+
# `SCHEDULED` with the new time;
|
|
2651
|
+
# * `ON_ACTIVATION` forbids `ScheduledSendAt`, and drops any time
|
|
2652
|
+
# already stored;
|
|
2653
|
+
# * `ScheduledSendAt` without `SendMode` is refused.
|
|
2654
|
+
#
|
|
2655
|
+
# PATCH: omitted leaves both unchanged. Until a mode is chosen the asset
|
|
2656
|
+
# reports `SEND_MODE_MISSING` and does not activate: no default, because
|
|
2657
|
+
# an unchosen send mails the real audience. Rejected with
|
|
2658
|
+
# `ValidationException` (`NOT_SUPPORTED_FOR_CATEGORY`) for a category
|
|
2659
|
+
# that has no send (`LANDING_PAGE`, `DOCUMENT`, `BANNER_AD`). Like every
|
|
2660
|
+
# other edit, it reaches the delivery platform at the asset's next
|
|
2661
|
+
# activation, and a live email or social post refuses it
|
|
2662
|
+
# (`ASSET_ALREADY_ACTIVE`): deactivate first.
|
|
2663
|
+
#
|
|
2664
|
+
# @option params [Time,DateTime,Date,Integer,String] :scheduled_send_at
|
|
2665
|
+
# The send time, with `SendMode: SCHEDULED` and only then. See
|
|
2666
|
+
# `SendMode`.
|
|
2667
|
+
#
|
|
2668
|
+
# Must be at least an hour out (`SEND_WINDOW_TOO_SOON`), unless it is
|
|
2669
|
+
# the time already stored: resending the stored mode and time changes
|
|
2670
|
+
# nothing and is accepted, so a form that always resubmits does not trip
|
|
2671
|
+
# the window.
|
|
2672
|
+
#
|
|
2673
|
+
# Must also fall on or before the campaign's `EndOn` (by the end of
|
|
2674
|
+
# that UTC day): refused with `ValidationException` (`INVALID_VALUE`)
|
|
2675
|
+
# otherwise, so nothing is scheduled to send after the campaign
|
|
2676
|
+
# completes.
|
|
2677
|
+
#
|
|
2678
|
+
# Was `scheduleDate`, a `YYYY-MM-DD` string. Retyped because a date
|
|
2679
|
+
# alone cannot express a send *time*, which is the whole point of a
|
|
2680
|
+
# schedule — and because the resource already spelled the same concept
|
|
2681
|
+
# `ScheduledSendAt` on the activation responses. Two spellings of one
|
|
2682
|
+
# concept on one resource was the defect.
|
|
2683
|
+
#
|
|
2684
|
+
# @option params [String] :client_token
|
|
2685
|
+
# Idempotency token. Retry-safety only — this is **not** a concurrency
|
|
2686
|
+
# token, and sequential edits to one field are last-writer-wins.
|
|
2687
|
+
#
|
|
2688
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2689
|
+
# not need to pass this option.**
|
|
2690
|
+
#
|
|
2691
|
+
# @return [Types::UpdateCampaignAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2692
|
+
#
|
|
2693
|
+
# * {Types::UpdateCampaignAssetResponse#id #id} => String
|
|
2694
|
+
# * {Types::UpdateCampaignAssetResponse#state #state} => String
|
|
2695
|
+
# * {Types::UpdateCampaignAssetResponse#activation_issues #activation_issues} => Array<Types::ActivationIssue>
|
|
2696
|
+
#
|
|
2697
|
+
#
|
|
2698
|
+
# @example Example: Update asset content
|
|
2699
|
+
#
|
|
2700
|
+
# resp = client.update_campaign_asset({
|
|
2701
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
2702
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2703
|
+
# catalog: "AWS",
|
|
2704
|
+
# field_values: [
|
|
2705
|
+
# {
|
|
2706
|
+
# field_id: "Subject",
|
|
2707
|
+
# value: {
|
|
2708
|
+
# text: "New subject line",
|
|
2709
|
+
# },
|
|
2710
|
+
# },
|
|
2711
|
+
# ],
|
|
2712
|
+
# })
|
|
2713
|
+
#
|
|
2714
|
+
# resp.to_h outputs the following:
|
|
2715
|
+
# {
|
|
2716
|
+
# activation_issues: [
|
|
2717
|
+
# {
|
|
2718
|
+
# code: "REQUIRED_FIELD_MISSING",
|
|
2719
|
+
# field_id: "Headline",
|
|
2720
|
+
# message: "This required field is empty.",
|
|
2721
|
+
# },
|
|
2722
|
+
# ],
|
|
2723
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
2724
|
+
# state: "ACTIVE",
|
|
2725
|
+
# }
|
|
2726
|
+
#
|
|
2727
|
+
# @example Example: Reschedule a sendable asset
|
|
2728
|
+
#
|
|
2729
|
+
# resp = client.update_campaign_asset({
|
|
2730
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
2731
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2732
|
+
# catalog: "AWS",
|
|
2733
|
+
# client_token: "f2a7c1e4-9b3d-4a51-8e6f-0c2d5b8a7e13",
|
|
2734
|
+
# scheduled_send_at: Time.parse(1793491200),
|
|
2735
|
+
# send_mode: "SCHEDULED",
|
|
2736
|
+
# })
|
|
2737
|
+
#
|
|
2738
|
+
# resp.to_h outputs the following:
|
|
2739
|
+
# {
|
|
2740
|
+
# activation_issues: [
|
|
2741
|
+
# ],
|
|
2742
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
2743
|
+
# state: "INACTIVE",
|
|
2744
|
+
# }
|
|
2745
|
+
#
|
|
2746
|
+
# @example Example: Copy an image from a previous campaign's asset
|
|
2747
|
+
#
|
|
2748
|
+
# # The image already stored on another of your assets is copied into this field. It is checked
|
|
2749
|
+
# # against this field's constraints and not scanned again. The call also needs
|
|
2750
|
+
# # partnercentral:GetCampaignAsset on the source campaign.
|
|
2751
|
+
#
|
|
2752
|
+
# resp = client.update_campaign_asset({
|
|
2753
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
2754
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2755
|
+
# catalog: "AWS",
|
|
2756
|
+
# field_values: [
|
|
2757
|
+
# {
|
|
2758
|
+
# field_id: "HeaderImage",
|
|
2759
|
+
# value: {
|
|
2760
|
+
# campaign_asset_image: {
|
|
2761
|
+
# campaign_asset_identifier: "ast-0f9e8d7c6b5a2",
|
|
2762
|
+
# campaign_identifier: "camp-2Lp7d9f3j6s1z",
|
|
2763
|
+
# field_id: "HeaderImage",
|
|
2764
|
+
# },
|
|
2765
|
+
# },
|
|
2766
|
+
# },
|
|
2767
|
+
# ],
|
|
2768
|
+
# })
|
|
2769
|
+
#
|
|
2770
|
+
# resp.to_h outputs the following:
|
|
2771
|
+
# {
|
|
2772
|
+
# activation_issues: [
|
|
2773
|
+
# ],
|
|
2774
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
2775
|
+
# state: "INACTIVE",
|
|
2776
|
+
# }
|
|
2777
|
+
#
|
|
2778
|
+
# @example Example: Use a suggested image from Build with AI
|
|
2779
|
+
#
|
|
2780
|
+
# # The URL Build with AI returned for a suggested image is sent unchanged as imageReference. The
|
|
2781
|
+
# # image is copied into this asset and not scanned. Any other URL is refused.
|
|
2782
|
+
#
|
|
2783
|
+
# resp = client.update_campaign_asset({
|
|
2784
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
2785
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2786
|
+
# catalog: "AWS",
|
|
2787
|
+
# field_values: [
|
|
2788
|
+
# {
|
|
2789
|
+
# field_id: "HeaderImage",
|
|
2790
|
+
# value: {
|
|
2791
|
+
# image_reference: "https://d111111abcdef8.cloudfront.net/suggested-image-url-from-build-with-ai.jpg",
|
|
2792
|
+
# },
|
|
2793
|
+
# },
|
|
2794
|
+
# ],
|
|
2795
|
+
# })
|
|
2796
|
+
#
|
|
2797
|
+
# resp.to_h outputs the following:
|
|
2798
|
+
# {
|
|
2799
|
+
# activation_issues: [
|
|
2800
|
+
# ],
|
|
2801
|
+
# id: "ast-4b81e0c9f2a7b",
|
|
2802
|
+
# state: "INACTIVE",
|
|
2803
|
+
# }
|
|
2804
|
+
#
|
|
2805
|
+
# @example Example: An update refused for two fields at once
|
|
2806
|
+
#
|
|
2807
|
+
# # Every failed field is reported in one refusal, and nothing applies — a declined image and an
|
|
2808
|
+
# # over-long headline arrive together in `fieldList`, each with its own `code`. This replaced a
|
|
2809
|
+
# # read-path `fileDetails[]` report (DG-040 Decision 11), so a partner handles image and text
|
|
2810
|
+
# # failures the same way.
|
|
2811
|
+
#
|
|
2812
|
+
# resp = client.update_campaign_asset({
|
|
2813
|
+
# campaign_asset_identifier: "ast-4b81e0c9f2a7b",
|
|
2814
|
+
# campaign_identifier: "camp-5Hq2m8x4k1p9w",
|
|
2815
|
+
# catalog: "AWS",
|
|
2816
|
+
# field_values: [
|
|
2817
|
+
# {
|
|
2818
|
+
# field_id: "HeaderImage",
|
|
2819
|
+
# value: {
|
|
2820
|
+
# image_reference: "s3://staging-bucket/123456789012/hero.png?versionId=v1",
|
|
2821
|
+
# },
|
|
2822
|
+
# },
|
|
2823
|
+
# {
|
|
2824
|
+
# field_id: "Headline",
|
|
2825
|
+
# value: {
|
|
2826
|
+
# text: "This headline is far longer than the field allows",
|
|
2827
|
+
# },
|
|
2828
|
+
# },
|
|
2829
|
+
# ],
|
|
2830
|
+
# })
|
|
2831
|
+
#
|
|
2832
|
+
# @example Request syntax with placeholder values
|
|
2833
|
+
#
|
|
2834
|
+
# resp = client.update_campaign_asset({
|
|
2835
|
+
# catalog: "AWS", # required, accepts AWS, Sandbox
|
|
2836
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
2837
|
+
# campaign_asset_identifier: "CampaignAssetId", # required
|
|
2838
|
+
# field_values: [
|
|
2839
|
+
# {
|
|
2840
|
+
# field_id: "TemplateFieldId", # required
|
|
2841
|
+
# value: {
|
|
2842
|
+
# text: "AssetBodyContent",
|
|
2843
|
+
# image_reference: "FileReference",
|
|
2844
|
+
# linked_asset_id: "CampaignAssetId",
|
|
2845
|
+
# campaign_asset_image: {
|
|
2846
|
+
# campaign_identifier: "CampaignIdentifier", # required
|
|
2847
|
+
# campaign_asset_identifier: "CampaignAssetId", # required
|
|
2848
|
+
# field_id: "TemplateFieldId", # required
|
|
2849
|
+
# },
|
|
2850
|
+
# },
|
|
2851
|
+
# },
|
|
2852
|
+
# ],
|
|
2853
|
+
# layout: "LayoutOptionValue",
|
|
2854
|
+
# send_mode: "ON_ACTIVATION", # accepts ON_ACTIVATION, SCHEDULED
|
|
2855
|
+
# scheduled_send_at: Time.now,
|
|
2856
|
+
# client_token: "ClientToken",
|
|
2857
|
+
# })
|
|
2858
|
+
#
|
|
2859
|
+
# @example Response structure
|
|
2860
|
+
#
|
|
2861
|
+
# resp.id #=> String
|
|
2862
|
+
# resp.state #=> String, one of "INACTIVE", "ACTIVE"
|
|
2863
|
+
# resp.activation_issues #=> Array
|
|
2864
|
+
# resp.activation_issues[0].code #=> String, one of "ASSET_NOT_FOUND", "ASSET_NOT_STARTABLE", "ASSET_START_IN_PROGRESS", "ASSET_ALREADY_ACTIVE", "SEND_WINDOW_TOO_SOON", "REQUIRED_FIELD_MISSING", "RECIPIENT_LIST_MISSING", "ENGAGEMENT_GROUPS_UNAVAILABLE", "SENDER_EMAIL_MISSING", "END_ON_MISSING", "ASSET_CONTENT_MISSING", "ASSET_NOT_ACTIVATABLE", "TEMPLATE_CHANGED", "PARTNER_IMAGE_REJECTED", "PREREQUISITE_ASSET_NOT_ACTIVE", "PARTNER_NOT_PROVISIONED", "RECIPIENT_LIST_EMPTY", "RECIPIENT_LIMIT_EXCEEDED", "CONTACT_OPT_IN_REQUIRED", "MAILING_CREDITS_EXHAUSTED", "SENDER_EMAIL_INVALID", "SOCIAL_CONNECTION_MISSING", "SOCIAL_CONNECTION_EXPIRED", "SOCIAL_CONNECTION_PAGE_REQUIRED", "DELIVERY_FAILED", "INTERNAL_ERROR", "MAILING_CREDITS_INSUFFICIENT", "PARTNER_PROFILE_FIELD_MISSING", "PARTNER_PROFILE_FIELD_DOES_NOT_FIT", "SOCIAL_CONNECTION_NOT_CHOSEN", "PRIVACY_POLICY_URL_MISSING", "PARTNER_ADDRESS_MISSING", "SEND_MODE_MISSING", "CONTENT_REJECTED", "URL_NOT_ALLOWED", "SENDER_NOT_APPROVED"
|
|
2865
|
+
# resp.activation_issues[0].field_id #=> String
|
|
2866
|
+
# resp.activation_issues[0].campaign_setting #=> String, one of "SENDER_EMAIL", "END_ON", "EMAIL_TARGET", "PRIVACY_POLICY_URL", "PARTNER_ADDRESS", "PARTNER_BADGE"
|
|
2867
|
+
# resp.activation_issues[0].partner_profile_field #=> String, one of "DISPLAY_NAME", "WEBSITE_URL", "LOGO", "WEBSITE_DOMAIN", "COPYRIGHT_LINE", "PARTNER_DETAILS", "COPYRIGHT_AND_DETAILS", "COPYRIGHT_YEAR_LINE"
|
|
2868
|
+
# resp.activation_issues[0].affected_asset_ids #=> Array
|
|
2869
|
+
# resp.activation_issues[0].affected_asset_ids[0] #=> String
|
|
2870
|
+
# resp.activation_issues[0].message #=> String
|
|
2871
|
+
#
|
|
2872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaignAsset AWS API Documentation
|
|
2873
|
+
#
|
|
2874
|
+
# @overload update_campaign_asset(params = {})
|
|
2875
|
+
# @param [Hash] params ({})
|
|
2876
|
+
def update_campaign_asset(params = {}, options = {})
|
|
2877
|
+
req = build_request(:update_campaign_asset, params)
|
|
2878
|
+
req.send_request(options)
|
|
2879
|
+
end
|
|
2880
|
+
|
|
2881
|
+
# @!endgroup
|
|
2882
|
+
|
|
2883
|
+
# @param params ({})
|
|
2884
|
+
# @api private
|
|
2885
|
+
def build_request(operation_name, params = {})
|
|
2886
|
+
handlers = @handlers.for(operation_name)
|
|
2887
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
2888
|
+
Aws::Telemetry.module_to_tracer_name('Aws::PartnerCentralMarketing')
|
|
2889
|
+
)
|
|
2890
|
+
context = Seahorse::Client::RequestContext.new(
|
|
2891
|
+
operation_name: operation_name,
|
|
2892
|
+
operation: config.api.operation(operation_name),
|
|
2893
|
+
client: self,
|
|
2894
|
+
params: params,
|
|
2895
|
+
config: config,
|
|
2896
|
+
tracer: tracer
|
|
2897
|
+
)
|
|
2898
|
+
context[:gem_name] = 'aws-sdk-partnercentralmarketing'
|
|
2899
|
+
context[:gem_version] = '1.0.0'
|
|
2900
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
2901
|
+
end
|
|
2902
|
+
|
|
2903
|
+
# @api private
|
|
2904
|
+
# @deprecated
|
|
2905
|
+
def waiter_names
|
|
2906
|
+
[]
|
|
2907
|
+
end
|
|
2908
|
+
|
|
2909
|
+
class << self
|
|
2910
|
+
|
|
2911
|
+
# @api private
|
|
2912
|
+
attr_reader :identifier
|
|
2913
|
+
|
|
2914
|
+
# @api private
|
|
2915
|
+
def errors_module
|
|
2916
|
+
Errors
|
|
2917
|
+
end
|
|
2918
|
+
|
|
2919
|
+
end
|
|
2920
|
+
end
|
|
2921
|
+
end
|