aws-sdk-apiportal 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-apiportal/client.rb +2860 -0
- data/lib/aws-sdk-apiportal/client_api.rb +1668 -0
- data/lib/aws-sdk-apiportal/customizations.rb +0 -0
- data/lib/aws-sdk-apiportal/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-apiportal/endpoint_provider.rb +56 -0
- data/lib/aws-sdk-apiportal/endpoints.rb +20 -0
- data/lib/aws-sdk-apiportal/errors.rb +134 -0
- data/lib/aws-sdk-apiportal/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-apiportal/resource.rb +26 -0
- data/lib/aws-sdk-apiportal/types.rb +3641 -0
- data/lib/aws-sdk-apiportal.rb +61 -0
- data/sig/client.rbs +744 -0
- data/sig/errors.rbs +34 -0
- data/sig/params.rbs +68 -0
- data/sig/resource.rbs +86 -0
- data/sig/types.rbs +1003 -0
- metadata +96 -0
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,744 @@
|
|
|
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 APIPortal
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/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 _AssociateManagedApisResponseSuccess
|
|
83
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AssociateManagedApisResponse]
|
|
84
|
+
def failed_items: () -> ::Array[Types::FailedManagedApiItem]
|
|
85
|
+
end
|
|
86
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#associate_managed_apis-instance_method
|
|
87
|
+
def associate_managed_apis: (
|
|
88
|
+
product_id: ::String,
|
|
89
|
+
managed_api_ids: Array[::String]
|
|
90
|
+
) -> _AssociateManagedApisResponseSuccess
|
|
91
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateManagedApisResponseSuccess
|
|
92
|
+
|
|
93
|
+
interface _CreateManagedApiResponseSuccess
|
|
94
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateManagedApiResponse]
|
|
95
|
+
def managed_api_id: () -> ::String
|
|
96
|
+
def managed_api_arn: () -> ::String
|
|
97
|
+
def api_signature: () -> Types::ApiSignature
|
|
98
|
+
def created_at: () -> ::Time
|
|
99
|
+
def updated_at: () -> ::Time
|
|
100
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
101
|
+
end
|
|
102
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_managed_api-instance_method
|
|
103
|
+
def create_managed_api: (
|
|
104
|
+
api_signature: {
|
|
105
|
+
resource_arn: ::String,
|
|
106
|
+
method: ("GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "ANY" | "HEAD" | "OPTIONS"),
|
|
107
|
+
hostname: ::String,
|
|
108
|
+
port: ::Integer,
|
|
109
|
+
path: ::String
|
|
110
|
+
},
|
|
111
|
+
?tags: Hash[::String, ::String]
|
|
112
|
+
) -> _CreateManagedApiResponseSuccess
|
|
113
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateManagedApiResponseSuccess
|
|
114
|
+
|
|
115
|
+
interface _CreatePortalResponseSuccess
|
|
116
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreatePortalResponse]
|
|
117
|
+
def portal_id: () -> ::String
|
|
118
|
+
def portal_arn: () -> ::String
|
|
119
|
+
def endpoint_configuration: () -> Types::EndpointConfigurationResponse
|
|
120
|
+
def authorization: () -> Types::Authorization
|
|
121
|
+
def portal_content: () -> Types::PortalContent
|
|
122
|
+
def included_product_arns: () -> ::Array[::String]
|
|
123
|
+
def publish_status: () -> ("PUBLISHED" | "PUBLISH_IN_PROGRESS" | "PUBLISH_FAILED" | "DISABLE_IN_PROGRESS" | "DISABLE_FAILED" | "DISABLED")
|
|
124
|
+
def status_exception: () -> Types::PortalStatusException
|
|
125
|
+
def updated_at: () -> ::Time
|
|
126
|
+
def published_at: () -> ::Time
|
|
127
|
+
def publish_description: () -> ::String
|
|
128
|
+
def rum_app_monitor_name: () -> ::String
|
|
129
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
130
|
+
end
|
|
131
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_portal-instance_method
|
|
132
|
+
def create_portal: (
|
|
133
|
+
portal_content: Params::portal_content,
|
|
134
|
+
endpoint_configuration: Params::endpoint_configuration_request,
|
|
135
|
+
authorization: Params::authorization,
|
|
136
|
+
?included_product_arns: Array[::String],
|
|
137
|
+
?logo_uri: ::String,
|
|
138
|
+
?rum_app_monitor_name: ::String,
|
|
139
|
+
?tags: Hash[::String, ::String]
|
|
140
|
+
) -> _CreatePortalResponseSuccess
|
|
141
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePortalResponseSuccess
|
|
142
|
+
|
|
143
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_portal_preview-instance_method
|
|
144
|
+
def create_portal_preview: (
|
|
145
|
+
portal_id: ::String
|
|
146
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
147
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
148
|
+
|
|
149
|
+
interface _CreateProductResponseSuccess
|
|
150
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProductResponse]
|
|
151
|
+
def product_id: () -> ::String
|
|
152
|
+
def product_arn: () -> ::String
|
|
153
|
+
def display_name: () -> ::String
|
|
154
|
+
def display_order: () -> Types::DisplayOrder
|
|
155
|
+
def description: () -> ::String
|
|
156
|
+
def updated_at: () -> ::Time
|
|
157
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
158
|
+
def api_selection_configuration: () -> Types::ApiSelectionConfiguration
|
|
159
|
+
def status: () -> ("ACTIVE" | "IN_PROGRESS" | "FAILED")
|
|
160
|
+
def failure_reason: () -> ("API_PAGE_ATTACHED" | "EVALUATION_ERROR")
|
|
161
|
+
end
|
|
162
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_product-instance_method
|
|
163
|
+
def create_product: (
|
|
164
|
+
display_name: ::String,
|
|
165
|
+
?description: ::String,
|
|
166
|
+
?tags: Hash[::String, ::String],
|
|
167
|
+
?api_selection_configuration: {
|
|
168
|
+
api_selection_mode: ("CUSTOM" | "RULE_BASED"),
|
|
169
|
+
rule_filters: Array[
|
|
170
|
+
{
|
|
171
|
+
key: ("RESOURCE_ARN" | "HOST" | "METHOD" | "PATH" | "PORT" | "ACCOUNT"),
|
|
172
|
+
values: Array[::String]
|
|
173
|
+
}
|
|
174
|
+
]?
|
|
175
|
+
}
|
|
176
|
+
) -> _CreateProductResponseSuccess
|
|
177
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProductResponseSuccess
|
|
178
|
+
|
|
179
|
+
interface _CreateProductApiPageResponseSuccess
|
|
180
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProductApiPageResponse]
|
|
181
|
+
def product_api_page_id: () -> ::String
|
|
182
|
+
def product_api_page_arn: () -> ::String
|
|
183
|
+
def api_id: () -> Types::ApiId
|
|
184
|
+
def display_content: () -> Types::ApiPageDisplayContentResponse
|
|
185
|
+
def try_it_state: () -> ("ENABLED" | "DISABLED")
|
|
186
|
+
def updated_at: () -> ::Time
|
|
187
|
+
def status: () -> ("AVAILABLE" | "IN_PROGRESS" | "FAILED")
|
|
188
|
+
def status_exception: () -> Types::ProductApiPageStatusException
|
|
189
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
190
|
+
end
|
|
191
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_product_api_page-instance_method
|
|
192
|
+
def create_product_api_page: (
|
|
193
|
+
product_id: ::String,
|
|
194
|
+
managed_api_id: ::String,
|
|
195
|
+
?display_content: Params::api_page_display_content,
|
|
196
|
+
?try_it_state: ("ENABLED" | "DISABLED"),
|
|
197
|
+
?tags: Hash[::String, ::String]
|
|
198
|
+
) -> _CreateProductApiPageResponseSuccess
|
|
199
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProductApiPageResponseSuccess
|
|
200
|
+
|
|
201
|
+
interface _CreateProductPageResponseSuccess
|
|
202
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProductPageResponse]
|
|
203
|
+
def product_page_id: () -> ::String
|
|
204
|
+
def product_page_arn: () -> ::String
|
|
205
|
+
def display_content: () -> Types::DisplayContent
|
|
206
|
+
def updated_at: () -> ::Time
|
|
207
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
208
|
+
end
|
|
209
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#create_product_page-instance_method
|
|
210
|
+
def create_product_page: (
|
|
211
|
+
product_id: ::String,
|
|
212
|
+
display_content: {
|
|
213
|
+
title: ::String,
|
|
214
|
+
body: ::String
|
|
215
|
+
},
|
|
216
|
+
?tags: Hash[::String, ::String]
|
|
217
|
+
) -> _CreateProductPageResponseSuccess
|
|
218
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProductPageResponseSuccess
|
|
219
|
+
|
|
220
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_discovery_configuration-instance_method
|
|
221
|
+
def delete_discovery_configuration: (
|
|
222
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
223
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
224
|
+
|
|
225
|
+
interface _DeleteManagedApiResponseSuccess
|
|
226
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteManagedApiResponse]
|
|
227
|
+
end
|
|
228
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_managed_api-instance_method
|
|
229
|
+
def delete_managed_api: (
|
|
230
|
+
managed_api_id: ::String
|
|
231
|
+
) -> _DeleteManagedApiResponseSuccess
|
|
232
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteManagedApiResponseSuccess
|
|
233
|
+
|
|
234
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_organization_discovery_configuration-instance_method
|
|
235
|
+
def delete_organization_discovery_configuration: (
|
|
236
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
237
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
238
|
+
|
|
239
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_portal-instance_method
|
|
240
|
+
def delete_portal: (
|
|
241
|
+
portal_id: ::String
|
|
242
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
243
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
244
|
+
|
|
245
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_product-instance_method
|
|
246
|
+
def delete_product: (
|
|
247
|
+
product_id: ::String
|
|
248
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
249
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
250
|
+
|
|
251
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_product_api_page-instance_method
|
|
252
|
+
def delete_product_api_page: (
|
|
253
|
+
product_id: ::String,
|
|
254
|
+
product_api_page_id: ::String
|
|
255
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
256
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
257
|
+
|
|
258
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_product_page-instance_method
|
|
259
|
+
def delete_product_page: (
|
|
260
|
+
product_id: ::String,
|
|
261
|
+
product_page_id: ::String
|
|
262
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
263
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
264
|
+
|
|
265
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#delete_product_sharing_policy-instance_method
|
|
266
|
+
def delete_product_sharing_policy: (
|
|
267
|
+
product_id: ::String
|
|
268
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
269
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
270
|
+
|
|
271
|
+
interface _DisassociateManagedApisResponseSuccess
|
|
272
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateManagedApisResponse]
|
|
273
|
+
def failed_items: () -> ::Array[Types::FailedManagedApiItem]
|
|
274
|
+
end
|
|
275
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#disassociate_managed_apis-instance_method
|
|
276
|
+
def disassociate_managed_apis: (
|
|
277
|
+
product_id: ::String,
|
|
278
|
+
managed_api_ids: Array[::String]
|
|
279
|
+
) -> _DisassociateManagedApisResponseSuccess
|
|
280
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateManagedApisResponseSuccess
|
|
281
|
+
|
|
282
|
+
interface _GetApiInventoryItemResponseSuccess
|
|
283
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetApiInventoryItemResponse]
|
|
284
|
+
def item: () -> Types::ApiInventoryItemDetail
|
|
285
|
+
end
|
|
286
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_api_inventory_item-instance_method
|
|
287
|
+
def get_api_inventory_item: (
|
|
288
|
+
method: ("GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "ANY" | "HEAD" | "OPTIONS"),
|
|
289
|
+
host: ::String,
|
|
290
|
+
port: ::Integer,
|
|
291
|
+
path: ::String,
|
|
292
|
+
resource_arn: ::String
|
|
293
|
+
) -> _GetApiInventoryItemResponseSuccess
|
|
294
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApiInventoryItemResponseSuccess
|
|
295
|
+
|
|
296
|
+
interface _GetDiscoveryConfigurationResponseSuccess
|
|
297
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDiscoveryConfigurationResponse]
|
|
298
|
+
def discovery_configuration: () -> Types::DiscoveryConfigurationData
|
|
299
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
300
|
+
end
|
|
301
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_discovery_configuration-instance_method
|
|
302
|
+
def get_discovery_configuration: (
|
|
303
|
+
) -> _GetDiscoveryConfigurationResponseSuccess
|
|
304
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDiscoveryConfigurationResponseSuccess
|
|
305
|
+
|
|
306
|
+
interface _GetManagedApiResponseSuccess
|
|
307
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetManagedApiResponse]
|
|
308
|
+
def managed_api_id: () -> ::String
|
|
309
|
+
def managed_api_arn: () -> ::String
|
|
310
|
+
def api_signature: () -> Types::ApiSignature
|
|
311
|
+
def created_at: () -> ::Time
|
|
312
|
+
def updated_at: () -> ::Time
|
|
313
|
+
def findings: () -> ::Array[Types::ManagedApiFinding]
|
|
314
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
315
|
+
end
|
|
316
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_managed_api-instance_method
|
|
317
|
+
def get_managed_api: (
|
|
318
|
+
managed_api_id: ::String
|
|
319
|
+
) -> _GetManagedApiResponseSuccess
|
|
320
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetManagedApiResponseSuccess
|
|
321
|
+
|
|
322
|
+
interface _GetOrganizationDiscoveryConfigurationResponseSuccess
|
|
323
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetOrganizationDiscoveryConfigurationResponse]
|
|
324
|
+
def discovery_configuration: () -> Types::OrganizationDiscoveryConfigurationData
|
|
325
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
326
|
+
end
|
|
327
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_organization_discovery_configuration-instance_method
|
|
328
|
+
def get_organization_discovery_configuration: (
|
|
329
|
+
) -> _GetOrganizationDiscoveryConfigurationResponseSuccess
|
|
330
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetOrganizationDiscoveryConfigurationResponseSuccess
|
|
331
|
+
|
|
332
|
+
interface _GetPortalResponseSuccess
|
|
333
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPortalResponse]
|
|
334
|
+
def portal_id: () -> ::String
|
|
335
|
+
def portal_arn: () -> ::String
|
|
336
|
+
def endpoint_configuration: () -> Types::EndpointConfigurationResponse
|
|
337
|
+
def authorization: () -> Types::Authorization
|
|
338
|
+
def portal_content: () -> Types::PortalContent
|
|
339
|
+
def included_product_arns: () -> ::Array[::String]
|
|
340
|
+
def publish_status: () -> ("PUBLISHED" | "PUBLISH_IN_PROGRESS" | "PUBLISH_FAILED" | "DISABLE_IN_PROGRESS" | "DISABLE_FAILED" | "DISABLED")
|
|
341
|
+
def status_exception: () -> Types::PortalStatusException
|
|
342
|
+
def updated_at: () -> ::Time
|
|
343
|
+
def published_at: () -> ::Time
|
|
344
|
+
def publish_description: () -> ::String
|
|
345
|
+
def rum_app_monitor_name: () -> ::String
|
|
346
|
+
def preview: () -> Types::Preview
|
|
347
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
348
|
+
end
|
|
349
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_portal-instance_method
|
|
350
|
+
def get_portal: (
|
|
351
|
+
portal_id: ::String
|
|
352
|
+
) -> _GetPortalResponseSuccess
|
|
353
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPortalResponseSuccess
|
|
354
|
+
|
|
355
|
+
interface _GetProductResponseSuccess
|
|
356
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetProductResponse]
|
|
357
|
+
def product_id: () -> ::String
|
|
358
|
+
def product_arn: () -> ::String
|
|
359
|
+
def display_name: () -> ::String
|
|
360
|
+
def display_order: () -> Types::DisplayOrder
|
|
361
|
+
def description: () -> ::String
|
|
362
|
+
def updated_at: () -> ::Time
|
|
363
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
364
|
+
def api_selection_configuration: () -> Types::ApiSelectionConfiguration
|
|
365
|
+
def status: () -> ("ACTIVE" | "IN_PROGRESS" | "FAILED")
|
|
366
|
+
def failure_reason: () -> ("API_PAGE_ATTACHED" | "EVALUATION_ERROR")
|
|
367
|
+
end
|
|
368
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_product-instance_method
|
|
369
|
+
def get_product: (
|
|
370
|
+
product_id: ::String,
|
|
371
|
+
?resource_owner_account_id: ::String
|
|
372
|
+
) -> _GetProductResponseSuccess
|
|
373
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProductResponseSuccess
|
|
374
|
+
|
|
375
|
+
interface _GetProductApiPageResponseSuccess
|
|
376
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetProductApiPageResponse]
|
|
377
|
+
def product_api_page_id: () -> ::String
|
|
378
|
+
def product_api_page_arn: () -> ::String
|
|
379
|
+
def api_id: () -> Types::ApiId
|
|
380
|
+
def display_content: () -> Types::ApiPageDisplayContentResponse
|
|
381
|
+
def try_it_state: () -> ("ENABLED" | "DISABLED")
|
|
382
|
+
def updated_at: () -> ::Time
|
|
383
|
+
def status: () -> ("AVAILABLE" | "IN_PROGRESS" | "FAILED")
|
|
384
|
+
def raw_display_content: () -> ::String
|
|
385
|
+
def status_exception: () -> Types::ProductApiPageStatusException
|
|
386
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
387
|
+
end
|
|
388
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_product_api_page-instance_method
|
|
389
|
+
def get_product_api_page: (
|
|
390
|
+
product_id: ::String,
|
|
391
|
+
product_api_page_id: ::String,
|
|
392
|
+
?resource_owner_account_id: ::String,
|
|
393
|
+
?include_raw_display_content: bool
|
|
394
|
+
) -> _GetProductApiPageResponseSuccess
|
|
395
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProductApiPageResponseSuccess
|
|
396
|
+
|
|
397
|
+
interface _GetProductPageResponseSuccess
|
|
398
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetProductPageResponse]
|
|
399
|
+
def product_page_id: () -> ::String
|
|
400
|
+
def product_page_arn: () -> ::String
|
|
401
|
+
def display_content: () -> Types::DisplayContent
|
|
402
|
+
def updated_at: () -> ::Time
|
|
403
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
404
|
+
end
|
|
405
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_product_page-instance_method
|
|
406
|
+
def get_product_page: (
|
|
407
|
+
product_id: ::String,
|
|
408
|
+
product_page_id: ::String,
|
|
409
|
+
?resource_owner_account_id: ::String
|
|
410
|
+
) -> _GetProductPageResponseSuccess
|
|
411
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProductPageResponseSuccess
|
|
412
|
+
|
|
413
|
+
interface _GetProductSharingPolicyResponseSuccess
|
|
414
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetProductSharingPolicyResponse]
|
|
415
|
+
def product_id: () -> ::String
|
|
416
|
+
def policy_document: () -> ::String
|
|
417
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
418
|
+
end
|
|
419
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#get_product_sharing_policy-instance_method
|
|
420
|
+
def get_product_sharing_policy: (
|
|
421
|
+
product_id: ::String
|
|
422
|
+
) -> _GetProductSharingPolicyResponseSuccess
|
|
423
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProductSharingPolicyResponseSuccess
|
|
424
|
+
|
|
425
|
+
interface _ListApiInventoryItemsResponseSuccess
|
|
426
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListApiInventoryItemsResponse]
|
|
427
|
+
def items: () -> ::Array[Types::ApiInventoryItem]
|
|
428
|
+
def next_token: () -> ::String
|
|
429
|
+
end
|
|
430
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_api_inventory_items-instance_method
|
|
431
|
+
def list_api_inventory_items: (
|
|
432
|
+
?filters: {
|
|
433
|
+
discovery_source: ("API_GATEWAY" | "ELB" | "CLOUDFRONT")?,
|
|
434
|
+
resource_arn: ::String?
|
|
435
|
+
},
|
|
436
|
+
?max_results: ::Integer,
|
|
437
|
+
?next_token: ::String
|
|
438
|
+
) -> _ListApiInventoryItemsResponseSuccess
|
|
439
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListApiInventoryItemsResponseSuccess
|
|
440
|
+
|
|
441
|
+
interface _ListDiscoveryStatusesResponseSuccess
|
|
442
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListDiscoveryStatusesResponse]
|
|
443
|
+
def items: () -> ::Array[Types::DiscoveryStatus]
|
|
444
|
+
def next_token: () -> ::String
|
|
445
|
+
end
|
|
446
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_discovery_statuses-instance_method
|
|
447
|
+
def list_discovery_statuses: (
|
|
448
|
+
?discovery_source: ("API_GATEWAY" | "ELB" | "CLOUDFRONT"),
|
|
449
|
+
?max_results: ::Integer,
|
|
450
|
+
?next_token: ::String
|
|
451
|
+
) -> _ListDiscoveryStatusesResponseSuccess
|
|
452
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDiscoveryStatusesResponseSuccess
|
|
453
|
+
|
|
454
|
+
interface _ListManagedApiEventsResponseSuccess
|
|
455
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListManagedApiEventsResponse]
|
|
456
|
+
def items: () -> ::Array[Types::ManagedApiEventSummary]
|
|
457
|
+
def next_token: () -> ::String
|
|
458
|
+
end
|
|
459
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_managed_api_events-instance_method
|
|
460
|
+
def list_managed_api_events: (
|
|
461
|
+
managed_api_id: ::String,
|
|
462
|
+
?started_after: ::Time,
|
|
463
|
+
?started_before: ::Time,
|
|
464
|
+
?max_results: ::Integer,
|
|
465
|
+
?next_token: ::String
|
|
466
|
+
) -> _ListManagedApiEventsResponseSuccess
|
|
467
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListManagedApiEventsResponseSuccess
|
|
468
|
+
|
|
469
|
+
interface _ListManagedApisResponseSuccess
|
|
470
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListManagedApisResponse]
|
|
471
|
+
def next_token: () -> ::String
|
|
472
|
+
def items: () -> ::Array[Types::ManagedApiSummary]
|
|
473
|
+
end
|
|
474
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_managed_apis-instance_method
|
|
475
|
+
def list_managed_apis: (
|
|
476
|
+
?max_results: ::Integer,
|
|
477
|
+
?next_token: ::String,
|
|
478
|
+
?product_id: ::String
|
|
479
|
+
) -> _ListManagedApisResponseSuccess
|
|
480
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListManagedApisResponseSuccess
|
|
481
|
+
|
|
482
|
+
interface _ListPortalsResponseSuccess
|
|
483
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPortalsResponse]
|
|
484
|
+
def items: () -> ::Array[Types::PortalSummary]
|
|
485
|
+
def next_token: () -> ::String
|
|
486
|
+
end
|
|
487
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_portals-instance_method
|
|
488
|
+
def list_portals: (
|
|
489
|
+
?max_results: ::Integer,
|
|
490
|
+
?next_token: ::String
|
|
491
|
+
) -> _ListPortalsResponseSuccess
|
|
492
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPortalsResponseSuccess
|
|
493
|
+
|
|
494
|
+
interface _ListProductApiPagesResponseSuccess
|
|
495
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListProductApiPagesResponse]
|
|
496
|
+
def next_token: () -> ::String
|
|
497
|
+
def items: () -> ::Array[Types::ProductApiPageSummaryNoBody]
|
|
498
|
+
end
|
|
499
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_product_api_pages-instance_method
|
|
500
|
+
def list_product_api_pages: (
|
|
501
|
+
product_id: ::String,
|
|
502
|
+
?next_token: ::String,
|
|
503
|
+
?max_results: ::Integer,
|
|
504
|
+
?resource_owner_account_id: ::String
|
|
505
|
+
) -> _ListProductApiPagesResponseSuccess
|
|
506
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListProductApiPagesResponseSuccess
|
|
507
|
+
|
|
508
|
+
interface _ListProductPagesResponseSuccess
|
|
509
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListProductPagesResponse]
|
|
510
|
+
def next_token: () -> ::String
|
|
511
|
+
def items: () -> ::Array[Types::ProductPageSummaryNoBody]
|
|
512
|
+
end
|
|
513
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_product_pages-instance_method
|
|
514
|
+
def list_product_pages: (
|
|
515
|
+
product_id: ::String,
|
|
516
|
+
?next_token: ::String,
|
|
517
|
+
?max_results: ::Integer,
|
|
518
|
+
?resource_owner_account_id: ::String
|
|
519
|
+
) -> _ListProductPagesResponseSuccess
|
|
520
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListProductPagesResponseSuccess
|
|
521
|
+
|
|
522
|
+
interface _ListProductsResponseSuccess
|
|
523
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListProductsResponse]
|
|
524
|
+
def next_token: () -> ::String
|
|
525
|
+
def items: () -> ::Array[Types::ProductSummary]
|
|
526
|
+
end
|
|
527
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_products-instance_method
|
|
528
|
+
def list_products: (
|
|
529
|
+
?max_results: ::Integer,
|
|
530
|
+
?next_token: ::String,
|
|
531
|
+
?resource_owner: ("ALL" | "SELF" | "OTHER_ACCOUNTS"),
|
|
532
|
+
?managed_api_id: ::String
|
|
533
|
+
) -> _ListProductsResponseSuccess
|
|
534
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListProductsResponseSuccess
|
|
535
|
+
|
|
536
|
+
interface _ListTagsForResourceResponseSuccess
|
|
537
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
|
538
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
539
|
+
end
|
|
540
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#list_tags_for_resource-instance_method
|
|
541
|
+
def list_tags_for_resource: (
|
|
542
|
+
resource_arn: ::String
|
|
543
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
544
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
545
|
+
|
|
546
|
+
interface _PutDiscoveryConfigurationResponseSuccess
|
|
547
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutDiscoveryConfigurationResponse]
|
|
548
|
+
def discovery_configuration: () -> Types::DiscoveryConfigurationData
|
|
549
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
550
|
+
end
|
|
551
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#put_discovery_configuration-instance_method
|
|
552
|
+
def put_discovery_configuration: (
|
|
553
|
+
?discovery_sources: Array[("API_GATEWAY" | "ELB" | "CLOUDFRONT")],
|
|
554
|
+
?excluded_resources: Array[::String],
|
|
555
|
+
?features: Array[("AI_DISCOVERY")],
|
|
556
|
+
?tags: Hash[::String, ::String]
|
|
557
|
+
) -> _PutDiscoveryConfigurationResponseSuccess
|
|
558
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDiscoveryConfigurationResponseSuccess
|
|
559
|
+
|
|
560
|
+
interface _PutOrganizationDiscoveryConfigurationResponseSuccess
|
|
561
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutOrganizationDiscoveryConfigurationResponse]
|
|
562
|
+
def discovery_configuration: () -> Types::OrganizationDiscoveryConfigurationData
|
|
563
|
+
def tags: () -> ::Hash[::String, ::String]
|
|
564
|
+
end
|
|
565
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#put_organization_discovery_configuration-instance_method
|
|
566
|
+
def put_organization_discovery_configuration: (
|
|
567
|
+
?discovery_sources: Array[("API_GATEWAY" | "ELB" | "CLOUDFRONT")],
|
|
568
|
+
?exclusion_filters: {
|
|
569
|
+
organizational_unit_ids: Array[::String]?,
|
|
570
|
+
account_ids: Array[::String]?,
|
|
571
|
+
resource_arns: Array[::String]?
|
|
572
|
+
},
|
|
573
|
+
?discovery_filters: {
|
|
574
|
+
exclusion_filters: {
|
|
575
|
+
organizational_unit_ids: Array[::String]?,
|
|
576
|
+
account_ids: Array[::String]?,
|
|
577
|
+
resource_arns: Array[::String]?
|
|
578
|
+
}?,
|
|
579
|
+
inclusion_filters: {
|
|
580
|
+
organizational_unit_ids: Array[::String]?,
|
|
581
|
+
account_ids: Array[::String]?
|
|
582
|
+
}?
|
|
583
|
+
},
|
|
584
|
+
?features: Array[("AI_DISCOVERY")],
|
|
585
|
+
?tags: Hash[::String, ::String]
|
|
586
|
+
) -> _PutOrganizationDiscoveryConfigurationResponseSuccess
|
|
587
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutOrganizationDiscoveryConfigurationResponseSuccess
|
|
588
|
+
|
|
589
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#put_product_sharing_policy-instance_method
|
|
590
|
+
def put_product_sharing_policy: (
|
|
591
|
+
product_id: ::String,
|
|
592
|
+
policy_document: ::String,
|
|
593
|
+
?tags: Hash[::String, ::String]
|
|
594
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
595
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
596
|
+
|
|
597
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#start_discovery-instance_method
|
|
598
|
+
def start_discovery: (
|
|
599
|
+
id: ::String
|
|
600
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
601
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
602
|
+
|
|
603
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#stop_discovery-instance_method
|
|
604
|
+
def stop_discovery: (
|
|
605
|
+
id: ::String
|
|
606
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
607
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
608
|
+
|
|
609
|
+
interface _TagResourceResponseSuccess
|
|
610
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
|
611
|
+
end
|
|
612
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#tag_resource-instance_method
|
|
613
|
+
def tag_resource: (
|
|
614
|
+
resource_arn: ::String,
|
|
615
|
+
tags: Hash[::String, ::String]
|
|
616
|
+
) -> _TagResourceResponseSuccess
|
|
617
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
|
618
|
+
|
|
619
|
+
interface _UntagResourceResponseSuccess
|
|
620
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
|
621
|
+
end
|
|
622
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#untag_resource-instance_method
|
|
623
|
+
def untag_resource: (
|
|
624
|
+
resource_arn: ::String,
|
|
625
|
+
tag_keys: Array[::String]
|
|
626
|
+
) -> _UntagResourceResponseSuccess
|
|
627
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
628
|
+
|
|
629
|
+
interface _UpdatePortalResponseSuccess
|
|
630
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePortalResponse]
|
|
631
|
+
def portal_id: () -> ::String
|
|
632
|
+
def portal_arn: () -> ::String
|
|
633
|
+
def endpoint_configuration: () -> Types::EndpointConfigurationResponse
|
|
634
|
+
def authorization: () -> Types::Authorization
|
|
635
|
+
def portal_content: () -> Types::PortalContent
|
|
636
|
+
def included_product_arns: () -> ::Array[::String]
|
|
637
|
+
def publish_status: () -> ("PUBLISHED" | "PUBLISH_IN_PROGRESS" | "PUBLISH_FAILED" | "DISABLE_IN_PROGRESS" | "DISABLE_FAILED" | "DISABLED")
|
|
638
|
+
def status_exception: () -> Types::PortalStatusException
|
|
639
|
+
def updated_at: () -> ::Time
|
|
640
|
+
def published_at: () -> ::Time
|
|
641
|
+
def publish_description: () -> ::String
|
|
642
|
+
def rum_app_monitor_name: () -> ::String
|
|
643
|
+
def preview: () -> Types::Preview
|
|
644
|
+
end
|
|
645
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#update_portal-instance_method
|
|
646
|
+
def update_portal: (
|
|
647
|
+
portal_id: ::String,
|
|
648
|
+
?portal_content: Params::portal_content,
|
|
649
|
+
?endpoint_configuration: Params::endpoint_configuration_request,
|
|
650
|
+
?authorization: Params::authorization,
|
|
651
|
+
?rum_app_monitor_name: ::String,
|
|
652
|
+
?included_product_arns: Array[::String],
|
|
653
|
+
?logo_uri: ::String
|
|
654
|
+
) -> _UpdatePortalResponseSuccess
|
|
655
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePortalResponseSuccess
|
|
656
|
+
|
|
657
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#update_portal_publish_status-instance_method
|
|
658
|
+
def update_portal_publish_status: (
|
|
659
|
+
portal_id: ::String,
|
|
660
|
+
status: ("PUBLISHED" | "DISABLED"),
|
|
661
|
+
?description: ::String
|
|
662
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
663
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
664
|
+
|
|
665
|
+
interface _UpdateProductResponseSuccess
|
|
666
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateProductResponse]
|
|
667
|
+
def product_id: () -> ::String
|
|
668
|
+
def product_arn: () -> ::String
|
|
669
|
+
def display_name: () -> ::String
|
|
670
|
+
def display_order: () -> Types::DisplayOrder
|
|
671
|
+
def description: () -> ::String
|
|
672
|
+
def updated_at: () -> ::Time
|
|
673
|
+
def api_selection_configuration: () -> Types::ApiSelectionConfiguration
|
|
674
|
+
def status: () -> ("ACTIVE" | "IN_PROGRESS" | "FAILED")
|
|
675
|
+
def failure_reason: () -> ("API_PAGE_ATTACHED" | "EVALUATION_ERROR")
|
|
676
|
+
end
|
|
677
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#update_product-instance_method
|
|
678
|
+
def update_product: (
|
|
679
|
+
product_id: ::String,
|
|
680
|
+
?display_name: ::String,
|
|
681
|
+
?description: ::String,
|
|
682
|
+
?display_order: {
|
|
683
|
+
overview_page_arn: ::String?,
|
|
684
|
+
product_page_arns: Array[::String]?,
|
|
685
|
+
contents: Array[
|
|
686
|
+
{
|
|
687
|
+
section_name: ::String?,
|
|
688
|
+
product_api_page_arns: Array[::String]?
|
|
689
|
+
}
|
|
690
|
+
]?
|
|
691
|
+
},
|
|
692
|
+
?api_selection_configuration: {
|
|
693
|
+
api_selection_mode: ("CUSTOM" | "RULE_BASED"),
|
|
694
|
+
rule_filters: Array[
|
|
695
|
+
{
|
|
696
|
+
key: ("RESOURCE_ARN" | "HOST" | "METHOD" | "PATH" | "PORT" | "ACCOUNT"),
|
|
697
|
+
values: Array[::String]
|
|
698
|
+
}
|
|
699
|
+
]?
|
|
700
|
+
}
|
|
701
|
+
) -> _UpdateProductResponseSuccess
|
|
702
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateProductResponseSuccess
|
|
703
|
+
|
|
704
|
+
interface _UpdateProductApiPageResponseSuccess
|
|
705
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateProductApiPageResponse]
|
|
706
|
+
def product_api_page_id: () -> ::String
|
|
707
|
+
def product_api_page_arn: () -> ::String
|
|
708
|
+
def api_id: () -> Types::ApiId
|
|
709
|
+
def display_content: () -> Types::ApiPageDisplayContentResponse
|
|
710
|
+
def try_it_state: () -> ("ENABLED" | "DISABLED")
|
|
711
|
+
def updated_at: () -> ::Time
|
|
712
|
+
def status: () -> ("AVAILABLE" | "IN_PROGRESS" | "FAILED")
|
|
713
|
+
def status_exception: () -> Types::ProductApiPageStatusException
|
|
714
|
+
end
|
|
715
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#update_product_api_page-instance_method
|
|
716
|
+
def update_product_api_page: (
|
|
717
|
+
product_id: ::String,
|
|
718
|
+
product_api_page_id: ::String,
|
|
719
|
+
?display_content: Params::api_page_display_content,
|
|
720
|
+
?try_it_state: ("ENABLED" | "DISABLED")
|
|
721
|
+
) -> _UpdateProductApiPageResponseSuccess
|
|
722
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateProductApiPageResponseSuccess
|
|
723
|
+
|
|
724
|
+
interface _UpdateProductPageResponseSuccess
|
|
725
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateProductPageResponse]
|
|
726
|
+
def product_page_id: () -> ::String
|
|
727
|
+
def product_page_arn: () -> ::String
|
|
728
|
+
def display_content: () -> Types::DisplayContent
|
|
729
|
+
def updated_at: () -> ::Time
|
|
730
|
+
end
|
|
731
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/APIPortal/Client.html#update_product_page-instance_method
|
|
732
|
+
def update_product_page: (
|
|
733
|
+
product_id: ::String,
|
|
734
|
+
product_page_id: ::String,
|
|
735
|
+
?display_content: {
|
|
736
|
+
title: ::String,
|
|
737
|
+
body: ::String
|
|
738
|
+
}
|
|
739
|
+
) -> _UpdateProductPageResponseSuccess
|
|
740
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateProductPageResponseSuccess
|
|
741
|
+
end
|
|
742
|
+
end
|
|
743
|
+
end
|
|
744
|
+
|