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,61 @@
|
|
|
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
|
+
|
|
11
|
+
require 'aws-sdk-core'
|
|
12
|
+
require 'aws-sigv4'
|
|
13
|
+
|
|
14
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:partnercentralmarketing)
|
|
15
|
+
|
|
16
|
+
# This module provides support for Partner Central Marketing API. This module is available in the
|
|
17
|
+
# `aws-sdk-partnercentralmarketing` gem.
|
|
18
|
+
#
|
|
19
|
+
# # Client
|
|
20
|
+
#
|
|
21
|
+
# The {Client} class provides one method for each API operation. Operation
|
|
22
|
+
# methods each accept a hash of request parameters and return a response
|
|
23
|
+
# structure.
|
|
24
|
+
#
|
|
25
|
+
# partner_central_marketing = Aws::PartnerCentralMarketing::Client.new
|
|
26
|
+
# resp = partner_central_marketing.batch_create_campaign_asset(params)
|
|
27
|
+
#
|
|
28
|
+
# See {Client} for more information.
|
|
29
|
+
#
|
|
30
|
+
# # Errors
|
|
31
|
+
#
|
|
32
|
+
# Errors returned from Partner Central Marketing API are defined in the
|
|
33
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
|
34
|
+
#
|
|
35
|
+
# begin
|
|
36
|
+
# # do stuff
|
|
37
|
+
# rescue Aws::PartnerCentralMarketing::Errors::ServiceError
|
|
38
|
+
# # rescues all Partner Central Marketing API API errors
|
|
39
|
+
# end
|
|
40
|
+
#
|
|
41
|
+
# See {Errors} for more information.
|
|
42
|
+
#
|
|
43
|
+
# @!group service
|
|
44
|
+
module Aws::PartnerCentralMarketing
|
|
45
|
+
autoload :Types, 'aws-sdk-partnercentralmarketing/types'
|
|
46
|
+
autoload :ClientApi, 'aws-sdk-partnercentralmarketing/client_api'
|
|
47
|
+
module Plugins
|
|
48
|
+
autoload :Endpoints, 'aws-sdk-partnercentralmarketing/plugins/endpoints.rb'
|
|
49
|
+
end
|
|
50
|
+
autoload :Client, 'aws-sdk-partnercentralmarketing/client'
|
|
51
|
+
autoload :Errors, 'aws-sdk-partnercentralmarketing/errors'
|
|
52
|
+
autoload :Resource, 'aws-sdk-partnercentralmarketing/resource'
|
|
53
|
+
autoload :EndpointParameters, 'aws-sdk-partnercentralmarketing/endpoint_parameters'
|
|
54
|
+
autoload :EndpointProvider, 'aws-sdk-partnercentralmarketing/endpoint_provider'
|
|
55
|
+
autoload :Endpoints, 'aws-sdk-partnercentralmarketing/endpoints'
|
|
56
|
+
|
|
57
|
+
GEM_VERSION = '1.0.0'
|
|
58
|
+
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
require_relative 'aws-sdk-partnercentralmarketing/customizations'
|
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,476 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws
|
|
9
|
+
module PartnerCentralMarketing
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#initialize-instance_method
|
|
14
|
+
def self.new: (
|
|
15
|
+
?credentials: untyped,
|
|
16
|
+
?region: String,
|
|
17
|
+
?access_key_id: String,
|
|
18
|
+
?account_id: String,
|
|
19
|
+
?active_endpoint_cache: bool,
|
|
20
|
+
?adaptive_retry_wait_to_fill: bool,
|
|
21
|
+
?auth_scheme_preference: Array[String],
|
|
22
|
+
?client_side_monitoring: bool,
|
|
23
|
+
?client_side_monitoring_client_id: String,
|
|
24
|
+
?client_side_monitoring_host: String,
|
|
25
|
+
?client_side_monitoring_port: Integer,
|
|
26
|
+
?client_side_monitoring_publisher: untyped,
|
|
27
|
+
?convert_params: bool,
|
|
28
|
+
?correct_clock_skew: bool,
|
|
29
|
+
?defaults_mode: String,
|
|
30
|
+
?disable_clock_skew_correction: bool,
|
|
31
|
+
?disable_host_prefix_injection: bool,
|
|
32
|
+
?disable_request_compression: bool,
|
|
33
|
+
?endpoint: String,
|
|
34
|
+
?endpoint_cache_max_entries: Integer,
|
|
35
|
+
?endpoint_cache_max_threads: Integer,
|
|
36
|
+
?endpoint_cache_poll_interval: Integer,
|
|
37
|
+
?endpoint_discovery: bool,
|
|
38
|
+
?ignore_configured_endpoint_urls: bool,
|
|
39
|
+
?log_formatter: untyped,
|
|
40
|
+
?log_level: Symbol,
|
|
41
|
+
?logger: untyped,
|
|
42
|
+
?max_attempts: Integer,
|
|
43
|
+
?profile: String,
|
|
44
|
+
?request_checksum_calculation: String,
|
|
45
|
+
?request_min_compression_size_bytes: Integer,
|
|
46
|
+
?response_checksum_validation: String,
|
|
47
|
+
?retry_backoff: Proc,
|
|
48
|
+
?retry_base_delay: Float,
|
|
49
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
|
50
|
+
?retry_limit: Integer,
|
|
51
|
+
?retry_max_delay: Integer,
|
|
52
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
|
53
|
+
?sdk_ua_app_id: String,
|
|
54
|
+
?secret_access_key: String,
|
|
55
|
+
?session_token: String,
|
|
56
|
+
?sigv4a_signing_region_set: Array[String],
|
|
57
|
+
?stub_responses: untyped,
|
|
58
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
|
59
|
+
?token_provider: untyped,
|
|
60
|
+
?use_dualstack_endpoint: bool,
|
|
61
|
+
?use_fips_endpoint: bool,
|
|
62
|
+
?validate_params: bool,
|
|
63
|
+
?endpoint_provider: untyped,
|
|
64
|
+
?http_proxy: String,
|
|
65
|
+
?http_open_timeout: (Float | Integer),
|
|
66
|
+
?http_read_timeout: (Float | Integer),
|
|
67
|
+
?http_idle_timeout: (Float | Integer),
|
|
68
|
+
?http_continue_timeout: (Float | Integer),
|
|
69
|
+
?ssl_timeout: (Float | Integer | nil),
|
|
70
|
+
?http_wire_trace: bool,
|
|
71
|
+
?ssl_verify_peer: bool,
|
|
72
|
+
?ssl_ca_bundle: String,
|
|
73
|
+
?ssl_ca_directory: String,
|
|
74
|
+
?ssl_ca_store: String,
|
|
75
|
+
?on_chunk_received: Proc,
|
|
76
|
+
?on_chunk_sent: Proc,
|
|
77
|
+
?raise_response_errors: bool
|
|
78
|
+
) -> instance
|
|
79
|
+
| (?Hash[Symbol, untyped]) -> instance
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
interface _BatchCreateCampaignAssetResponseSuccess
|
|
83
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchCreateCampaignAssetResponse]
|
|
84
|
+
def errors: () -> ::Array[Types::BatchCreateCampaignAssetError]
|
|
85
|
+
def successful: () -> ::Array[Types::BatchCreateCampaignAssetResult]
|
|
86
|
+
end
|
|
87
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#batch_create_campaign_asset-instance_method
|
|
88
|
+
def batch_create_campaign_asset: (
|
|
89
|
+
catalog: ("AWS" | "Sandbox"),
|
|
90
|
+
campaign_identifier: ::String,
|
|
91
|
+
entries: Array[
|
|
92
|
+
{
|
|
93
|
+
source_asset_template_identifier: ::String
|
|
94
|
+
}
|
|
95
|
+
]
|
|
96
|
+
) -> _BatchCreateCampaignAssetResponseSuccess
|
|
97
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchCreateCampaignAssetResponseSuccess
|
|
98
|
+
|
|
99
|
+
interface _CreateCampaignResponseSuccess
|
|
100
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCampaignResponse]
|
|
101
|
+
def id: () -> ::String
|
|
102
|
+
def arn: () -> ::String
|
|
103
|
+
end
|
|
104
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#create_campaign-instance_method
|
|
105
|
+
def create_campaign: (
|
|
106
|
+
catalog: ("AWS" | "Sandbox"),
|
|
107
|
+
name: ::String,
|
|
108
|
+
campaign_template_id: ::String,
|
|
109
|
+
?sender_email: ::String,
|
|
110
|
+
?privacy_policy_url: ::String,
|
|
111
|
+
?partner_address: ::String,
|
|
112
|
+
?partner_badge: {
|
|
113
|
+
s3_uri: ::String,
|
|
114
|
+
version_id: ::String
|
|
115
|
+
},
|
|
116
|
+
?email_target: {
|
|
117
|
+
s3_uri: ::String,
|
|
118
|
+
version_id: ::String
|
|
119
|
+
},
|
|
120
|
+
?email_target_engagement_group_ids: Array[::String],
|
|
121
|
+
?target_audience: {
|
|
122
|
+
industries: Array[("FINANCIAL_SERVICES" | "HEALTHCARE" | "MANUFACTURING" | "RETAIL" | "MEDIA_ENTERTAINMENT" | "ENERGY" | "EDUCATION" | "GOVERNMENT" | "TELECOMMUNICATIONS" | "AUTOMOTIVE" | "INSURANCE" | "OTHER")]?,
|
|
123
|
+
company_sizes: Array[("STARTUP" | "SMALL_BUSINESS" | "MID_MARKET" | "ENTERPRISE" | "GLOBAL_ENTERPRISE")]?,
|
|
124
|
+
countries: Array[::String]?
|
|
125
|
+
},
|
|
126
|
+
?estimated_budget: {
|
|
127
|
+
amount: ::String,
|
|
128
|
+
currency_code: ::String
|
|
129
|
+
},
|
|
130
|
+
?total_budget: {
|
|
131
|
+
amount: ::String,
|
|
132
|
+
currency_code: ::String
|
|
133
|
+
},
|
|
134
|
+
?start_on: ::String,
|
|
135
|
+
?end_on: ::String,
|
|
136
|
+
?client_token: ::String,
|
|
137
|
+
?tags: Array[
|
|
138
|
+
{
|
|
139
|
+
key: ::String,
|
|
140
|
+
value: ::String
|
|
141
|
+
}
|
|
142
|
+
]
|
|
143
|
+
) -> _CreateCampaignResponseSuccess
|
|
144
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCampaignResponseSuccess
|
|
145
|
+
|
|
146
|
+
interface _CreateSocialConnectionAuthorizationUrlResponseSuccess
|
|
147
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateSocialConnectionAuthorizationUrlResponse]
|
|
148
|
+
def platform: () -> ("FACEBOOK" | "LINKEDIN" | "X")
|
|
149
|
+
def authorization_url: () -> ::String
|
|
150
|
+
end
|
|
151
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#create_social_connection_authorization_url-instance_method
|
|
152
|
+
def create_social_connection_authorization_url: (
|
|
153
|
+
catalog: ("AWS" | "Sandbox"),
|
|
154
|
+
platform: ("FACEBOOK" | "LINKEDIN" | "X")
|
|
155
|
+
) -> _CreateSocialConnectionAuthorizationUrlResponseSuccess
|
|
156
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSocialConnectionAuthorizationUrlResponseSuccess
|
|
157
|
+
|
|
158
|
+
interface _DeactivateCampaignAssetResponseSuccess
|
|
159
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeactivateCampaignAssetResponse]
|
|
160
|
+
def id: () -> ::String
|
|
161
|
+
def state: () -> ("INACTIVE" | "ACTIVE")
|
|
162
|
+
def last_activation_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
|
163
|
+
def state_reason: () -> ("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")
|
|
164
|
+
end
|
|
165
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#deactivate_campaign_asset-instance_method
|
|
166
|
+
def deactivate_campaign_asset: (
|
|
167
|
+
catalog: ("AWS" | "Sandbox"),
|
|
168
|
+
campaign_identifier: ::String,
|
|
169
|
+
campaign_asset_identifier: ::String
|
|
170
|
+
) -> _DeactivateCampaignAssetResponseSuccess
|
|
171
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeactivateCampaignAssetResponseSuccess
|
|
172
|
+
|
|
173
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#delete_campaign-instance_method
|
|
174
|
+
def delete_campaign: (
|
|
175
|
+
catalog: ("AWS" | "Sandbox"),
|
|
176
|
+
campaign_identifier: ::String
|
|
177
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
178
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
179
|
+
|
|
180
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#delete_campaign_asset-instance_method
|
|
181
|
+
def delete_campaign_asset: (
|
|
182
|
+
catalog: ("AWS" | "Sandbox"),
|
|
183
|
+
campaign_identifier: ::String,
|
|
184
|
+
campaign_asset_identifier: ::String
|
|
185
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
186
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
187
|
+
|
|
188
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#delete_social_connection-instance_method
|
|
189
|
+
def delete_social_connection: (
|
|
190
|
+
catalog: ("AWS" | "Sandbox"),
|
|
191
|
+
identifier: ::String,
|
|
192
|
+
?client_token: ::String
|
|
193
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
194
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
195
|
+
|
|
196
|
+
interface _GetCampaignResponseSuccess
|
|
197
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignResponse]
|
|
198
|
+
def campaign: () -> Types::Campaign
|
|
199
|
+
end
|
|
200
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#get_campaign-instance_method
|
|
201
|
+
def get_campaign: (
|
|
202
|
+
catalog: ("AWS" | "Sandbox"),
|
|
203
|
+
campaign_identifier: ::String
|
|
204
|
+
) -> _GetCampaignResponseSuccess
|
|
205
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignResponseSuccess
|
|
206
|
+
|
|
207
|
+
interface _GetCampaignAssetResponseSuccess
|
|
208
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignAssetResponse]
|
|
209
|
+
def asset: () -> Types::CampaignAsset
|
|
210
|
+
end
|
|
211
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#get_campaign_asset-instance_method
|
|
212
|
+
def get_campaign_asset: (
|
|
213
|
+
catalog: ("AWS" | "Sandbox"),
|
|
214
|
+
campaign_identifier: ::String,
|
|
215
|
+
campaign_asset_identifier: ::String
|
|
216
|
+
) -> _GetCampaignAssetResponseSuccess
|
|
217
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignAssetResponseSuccess
|
|
218
|
+
|
|
219
|
+
interface _GetCampaignAssetActivationTaskResponseSuccess
|
|
220
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignAssetActivationTaskResponse]
|
|
221
|
+
def campaign_id: () -> ::String
|
|
222
|
+
def task_id: () -> ::String
|
|
223
|
+
def task_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "PARTIAL_FAILURE" | "FAILED")
|
|
224
|
+
def started_at: () -> ::Time
|
|
225
|
+
def ended_at: () -> ::Time
|
|
226
|
+
def assets: () -> ::Array[Types::CampaignAssetActivationOutcome]
|
|
227
|
+
end
|
|
228
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#get_campaign_asset_activation_task-instance_method
|
|
229
|
+
def get_campaign_asset_activation_task: (
|
|
230
|
+
catalog: ("AWS" | "Sandbox"),
|
|
231
|
+
campaign_identifier: ::String
|
|
232
|
+
) -> _GetCampaignAssetActivationTaskResponseSuccess
|
|
233
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignAssetActivationTaskResponseSuccess
|
|
234
|
+
|
|
235
|
+
interface _GetCampaignAssetExportTaskResponseSuccess
|
|
236
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignAssetExportTaskResponse]
|
|
237
|
+
def id: () -> ::String
|
|
238
|
+
def status: () -> ("IN_PROGRESS" | "COMPLETED" | "FAILED")
|
|
239
|
+
def created_at: () -> ::Time
|
|
240
|
+
def download_url: () -> ::String
|
|
241
|
+
def expires_at: () -> ::Time
|
|
242
|
+
def failure_reason: () -> Types::CampaignAssetExportFailureReason
|
|
243
|
+
end
|
|
244
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#get_campaign_asset_export_task-instance_method
|
|
245
|
+
def get_campaign_asset_export_task: (
|
|
246
|
+
catalog: ("AWS" | "Sandbox"),
|
|
247
|
+
campaign_identifier: ::String,
|
|
248
|
+
campaign_asset_export_task_identifier: ::String
|
|
249
|
+
) -> _GetCampaignAssetExportTaskResponseSuccess
|
|
250
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignAssetExportTaskResponseSuccess
|
|
251
|
+
|
|
252
|
+
interface _GetCampaignTemplateResponseSuccess
|
|
253
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignTemplateResponse]
|
|
254
|
+
def campaign_template: () -> Types::CampaignTemplate
|
|
255
|
+
end
|
|
256
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#get_campaign_template-instance_method
|
|
257
|
+
def get_campaign_template: (
|
|
258
|
+
catalog: ("AWS" | "Sandbox"),
|
|
259
|
+
identifier: ::String
|
|
260
|
+
) -> _GetCampaignTemplateResponseSuccess
|
|
261
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignTemplateResponseSuccess
|
|
262
|
+
|
|
263
|
+
interface _ListCampaignAssetsResponseSuccess
|
|
264
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCampaignAssetsResponse]
|
|
265
|
+
def items: () -> ::Array[Types::CampaignAssetSummary]
|
|
266
|
+
def next_token: () -> ::String
|
|
267
|
+
end
|
|
268
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#list_campaign_assets-instance_method
|
|
269
|
+
def list_campaign_assets: (
|
|
270
|
+
catalog: ("AWS" | "Sandbox"),
|
|
271
|
+
campaign_identifier: ::String,
|
|
272
|
+
?max_results: ::Integer,
|
|
273
|
+
?next_token: ::String
|
|
274
|
+
) -> _ListCampaignAssetsResponseSuccess
|
|
275
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCampaignAssetsResponseSuccess
|
|
276
|
+
|
|
277
|
+
interface _ListCampaignsResponseSuccess
|
|
278
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCampaignsResponse]
|
|
279
|
+
def items: () -> ::Array[Types::CampaignSummary]
|
|
280
|
+
def next_token: () -> ::String
|
|
281
|
+
end
|
|
282
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#list_campaigns-instance_method
|
|
283
|
+
def list_campaigns: (
|
|
284
|
+
catalog: ("AWS" | "Sandbox"),
|
|
285
|
+
?campaign_identifiers: Array[::String],
|
|
286
|
+
?name: ::String,
|
|
287
|
+
?states: Array[("DRAFT" | "ACTIVE" | "COMPLETED")],
|
|
288
|
+
?sort: {
|
|
289
|
+
sort_by: ("NAME" | "STATE" | "START_ON" | "CREATED_AT"),
|
|
290
|
+
sort_order: ("ASCENDING" | "DESCENDING")
|
|
291
|
+
},
|
|
292
|
+
?max_results: ::Integer,
|
|
293
|
+
?next_token: ::String
|
|
294
|
+
) -> _ListCampaignsResponseSuccess
|
|
295
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCampaignsResponseSuccess
|
|
296
|
+
|
|
297
|
+
interface _ListSocialConnectionsResponseSuccess
|
|
298
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSocialConnectionsResponse]
|
|
299
|
+
def items: () -> ::Array[Types::SocialConnectionSummary]
|
|
300
|
+
def next_token: () -> ::String
|
|
301
|
+
end
|
|
302
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#list_social_connections-instance_method
|
|
303
|
+
def list_social_connections: (
|
|
304
|
+
catalog: ("AWS" | "Sandbox"),
|
|
305
|
+
?platform: ("FACEBOOK" | "LINKEDIN" | "X"),
|
|
306
|
+
?max_results: ::Integer,
|
|
307
|
+
?next_token: ::String
|
|
308
|
+
) -> _ListSocialConnectionsResponseSuccess
|
|
309
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSocialConnectionsResponseSuccess
|
|
310
|
+
|
|
311
|
+
interface _ListTagsForResourceResponseSuccess
|
|
312
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
|
313
|
+
def resource_arn: () -> ::String
|
|
314
|
+
def tags: () -> ::Array[Types::Tag]
|
|
315
|
+
end
|
|
316
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#list_tags_for_resource-instance_method
|
|
317
|
+
def list_tags_for_resource: (
|
|
318
|
+
resource_arn: ::String
|
|
319
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
320
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
321
|
+
|
|
322
|
+
interface _SearchCampaignTemplatesResponseSuccess
|
|
323
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchCampaignTemplatesResponse]
|
|
324
|
+
def total_results: () -> ::Integer
|
|
325
|
+
def campaign_templates: () -> ::Array[Types::CampaignTemplateSummary]
|
|
326
|
+
def next_token: () -> ::String
|
|
327
|
+
end
|
|
328
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#search_campaign_templates-instance_method
|
|
329
|
+
def search_campaign_templates: (
|
|
330
|
+
catalog: ("AWS" | "Sandbox"),
|
|
331
|
+
?search_text: ::String,
|
|
332
|
+
?industry: Array[("FINANCIAL_SERVICES" | "HEALTHCARE" | "MANUFACTURING" | "RETAIL" | "MEDIA_ENTERTAINMENT" | "ENERGY" | "EDUCATION" | "GOVERNMENT" | "TELECOMMUNICATIONS" | "AUTOMOTIVE" | "INSURANCE" | "OTHER")],
|
|
333
|
+
?use_case: Array[::String],
|
|
334
|
+
?language: Array[("en" | "es" | "es-419" | "fr" | "de" | "it" | "pt-BR" | "id" | "tr" | "ja" | "ko" | "zh-Hans" | "zh-Hant" | "ar")],
|
|
335
|
+
?aws_services: Array[::String],
|
|
336
|
+
?customer_segments: Array[("ENTERPRISE" | "SMB" | "PUBLIC_SECTOR" | "ISV")],
|
|
337
|
+
?themes: Array[("AI" | "MIGRATION_MODERNIZATION" | "SECURITY" | "DATA_ANALYTICS" | "AWS_TRAINING_CERTIFICATION" | "AWS_MARKETPLACE" | "CONNECT" | "EVENTS")],
|
|
338
|
+
?collection: Array[("GENERAL" | "BUILD_WITH_AI")],
|
|
339
|
+
?max_results: ::Integer,
|
|
340
|
+
?next_token: ::String
|
|
341
|
+
) -> _SearchCampaignTemplatesResponseSuccess
|
|
342
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchCampaignTemplatesResponseSuccess
|
|
343
|
+
|
|
344
|
+
interface _StartCampaignAssetActivationTaskResponseSuccess
|
|
345
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartCampaignAssetActivationTaskResponse]
|
|
346
|
+
def campaign_id: () -> ::String
|
|
347
|
+
def task_id: () -> ::String
|
|
348
|
+
def task_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "PARTIAL_FAILURE" | "FAILED")
|
|
349
|
+
def started_at: () -> ::Time
|
|
350
|
+
def ended_at: () -> ::Time
|
|
351
|
+
def assets: () -> ::Array[Types::CampaignAssetActivationOutcome]
|
|
352
|
+
end
|
|
353
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#start_campaign_asset_activation_task-instance_method
|
|
354
|
+
def start_campaign_asset_activation_task: (
|
|
355
|
+
catalog: ("AWS" | "Sandbox"),
|
|
356
|
+
campaign_identifier: ::String,
|
|
357
|
+
campaign_asset_identifiers: Array[::String],
|
|
358
|
+
?client_token: ::String
|
|
359
|
+
) -> _StartCampaignAssetActivationTaskResponseSuccess
|
|
360
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCampaignAssetActivationTaskResponseSuccess
|
|
361
|
+
|
|
362
|
+
interface _StartCampaignAssetExportTaskResponseSuccess
|
|
363
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartCampaignAssetExportTaskResponse]
|
|
364
|
+
def id: () -> ::String
|
|
365
|
+
def status: () -> ("IN_PROGRESS" | "COMPLETED" | "FAILED")
|
|
366
|
+
end
|
|
367
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#start_campaign_asset_export_task-instance_method
|
|
368
|
+
def start_campaign_asset_export_task: (
|
|
369
|
+
catalog: ("AWS" | "Sandbox"),
|
|
370
|
+
campaign_identifier: ::String,
|
|
371
|
+
?client_token: ::String
|
|
372
|
+
) -> _StartCampaignAssetExportTaskResponseSuccess
|
|
373
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCampaignAssetExportTaskResponseSuccess
|
|
374
|
+
|
|
375
|
+
interface _TagResourceResponseSuccess
|
|
376
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
|
377
|
+
end
|
|
378
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#tag_resource-instance_method
|
|
379
|
+
def tag_resource: (
|
|
380
|
+
resource_arn: ::String,
|
|
381
|
+
tags: Array[
|
|
382
|
+
{
|
|
383
|
+
key: ::String,
|
|
384
|
+
value: ::String
|
|
385
|
+
}
|
|
386
|
+
]
|
|
387
|
+
) -> _TagResourceResponseSuccess
|
|
388
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
|
389
|
+
|
|
390
|
+
interface _UntagResourceResponseSuccess
|
|
391
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
|
392
|
+
end
|
|
393
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#untag_resource-instance_method
|
|
394
|
+
def untag_resource: (
|
|
395
|
+
resource_arn: ::String,
|
|
396
|
+
tag_keys: Array[::String]
|
|
397
|
+
) -> _UntagResourceResponseSuccess
|
|
398
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
399
|
+
|
|
400
|
+
interface _UpdateCampaignResponseSuccess
|
|
401
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCampaignResponse]
|
|
402
|
+
def id: () -> ::String
|
|
403
|
+
end
|
|
404
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#update_campaign-instance_method
|
|
405
|
+
def update_campaign: (
|
|
406
|
+
catalog: ("AWS" | "Sandbox"),
|
|
407
|
+
campaign_identifier: ::String,
|
|
408
|
+
?name: ::String,
|
|
409
|
+
?sender_email: ::String,
|
|
410
|
+
?privacy_policy_url: ::String,
|
|
411
|
+
?partner_address: ::String,
|
|
412
|
+
?partner_badge: {
|
|
413
|
+
s3_uri: ::String,
|
|
414
|
+
version_id: ::String
|
|
415
|
+
},
|
|
416
|
+
?email_target: {
|
|
417
|
+
s3_uri: ::String,
|
|
418
|
+
version_id: ::String
|
|
419
|
+
},
|
|
420
|
+
?email_target_engagement_group_ids: Array[::String],
|
|
421
|
+
?social_connections: Hash[("FACEBOOK" | "LINKEDIN" | "X"), Array[::String]],
|
|
422
|
+
?estimated_budget: {
|
|
423
|
+
amount: ::String,
|
|
424
|
+
currency_code: ::String
|
|
425
|
+
},
|
|
426
|
+
?total_budget: {
|
|
427
|
+
amount: ::String,
|
|
428
|
+
currency_code: ::String
|
|
429
|
+
},
|
|
430
|
+
?target_audience: {
|
|
431
|
+
industries: Array[("FINANCIAL_SERVICES" | "HEALTHCARE" | "MANUFACTURING" | "RETAIL" | "MEDIA_ENTERTAINMENT" | "ENERGY" | "EDUCATION" | "GOVERNMENT" | "TELECOMMUNICATIONS" | "AUTOMOTIVE" | "INSURANCE" | "OTHER")]?,
|
|
432
|
+
company_sizes: Array[("STARTUP" | "SMALL_BUSINESS" | "MID_MARKET" | "ENTERPRISE" | "GLOBAL_ENTERPRISE")]?,
|
|
433
|
+
countries: Array[::String]?
|
|
434
|
+
},
|
|
435
|
+
?client_token: ::String,
|
|
436
|
+
?start_on: ::String,
|
|
437
|
+
?end_on: ::String
|
|
438
|
+
) -> _UpdateCampaignResponseSuccess
|
|
439
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCampaignResponseSuccess
|
|
440
|
+
|
|
441
|
+
interface _UpdateCampaignAssetResponseSuccess
|
|
442
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCampaignAssetResponse]
|
|
443
|
+
def id: () -> ::String
|
|
444
|
+
def state: () -> ("INACTIVE" | "ACTIVE")
|
|
445
|
+
def activation_issues: () -> ::Array[Types::ActivationIssue]
|
|
446
|
+
end
|
|
447
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PartnerCentralMarketing/Client.html#update_campaign_asset-instance_method
|
|
448
|
+
def update_campaign_asset: (
|
|
449
|
+
catalog: ("AWS" | "Sandbox"),
|
|
450
|
+
campaign_identifier: ::String,
|
|
451
|
+
campaign_asset_identifier: ::String,
|
|
452
|
+
?field_values: Array[
|
|
453
|
+
{
|
|
454
|
+
field_id: ::String,
|
|
455
|
+
value: {
|
|
456
|
+
text: ::String?,
|
|
457
|
+
image_reference: ::String?,
|
|
458
|
+
linked_asset_id: ::String?,
|
|
459
|
+
campaign_asset_image: {
|
|
460
|
+
campaign_identifier: ::String,
|
|
461
|
+
campaign_asset_identifier: ::String,
|
|
462
|
+
field_id: ::String
|
|
463
|
+
}?
|
|
464
|
+
}?
|
|
465
|
+
}
|
|
466
|
+
],
|
|
467
|
+
?layout: ::String,
|
|
468
|
+
?send_mode: ("ON_ACTIVATION" | "SCHEDULED"),
|
|
469
|
+
?scheduled_send_at: ::Time,
|
|
470
|
+
?client_token: ::String
|
|
471
|
+
) -> _UpdateCampaignAssetResponseSuccess
|
|
472
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCampaignAssetResponseSuccess
|
|
473
|
+
end
|
|
474
|
+
end
|
|
475
|
+
end
|
|
476
|
+
|
data/sig/errors.rbs
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws
|
|
9
|
+
module PartnerCentralMarketing
|
|
10
|
+
module Errors
|
|
11
|
+
class ServiceError < ::Aws::Errors::ServiceError
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
class AccessDeniedException < ServiceError
|
|
15
|
+
def message: () -> ::String
|
|
16
|
+
def reason: () -> ::String
|
|
17
|
+
end
|
|
18
|
+
class ConflictException < ServiceError
|
|
19
|
+
def message: () -> ::String
|
|
20
|
+
def resource_id: () -> ::String
|
|
21
|
+
def resource_type: () -> ::String
|
|
22
|
+
def reason: () -> ::String
|
|
23
|
+
end
|
|
24
|
+
class InternalServerException < ServiceError
|
|
25
|
+
def message: () -> ::String
|
|
26
|
+
def retry_after_seconds: () -> ::String
|
|
27
|
+
end
|
|
28
|
+
class ResourceNotFoundException < ServiceError
|
|
29
|
+
def message: () -> ::String
|
|
30
|
+
def resource_id: () -> ::String
|
|
31
|
+
def resource_type: () -> ::String
|
|
32
|
+
end
|
|
33
|
+
class ServiceQuotaExceededException < ServiceError
|
|
34
|
+
def message: () -> ::String
|
|
35
|
+
def resource_type: () -> ::String
|
|
36
|
+
def quota_code: () -> ::String
|
|
37
|
+
def service_code: () -> ::String
|
|
38
|
+
end
|
|
39
|
+
class ThrottlingException < ServiceError
|
|
40
|
+
def message: () -> ::String
|
|
41
|
+
def retry_after_seconds: () -> ::String
|
|
42
|
+
end
|
|
43
|
+
class ValidationException < ServiceError
|
|
44
|
+
def message: () -> ::String
|
|
45
|
+
def reason: () -> ::String
|
|
46
|
+
def field_list: () -> ::String
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|