aws-sdk-b2bi 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-b2bi/client.rb +2577 -0
- data/lib/aws-sdk-b2bi/client_api.rb +934 -0
- data/lib/aws-sdk-b2bi/customizations.rb +0 -0
- data/lib/aws-sdk-b2bi/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-b2bi/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-b2bi/endpoints.rb +394 -0
- data/lib/aws-sdk-b2bi/errors.rb +188 -0
- data/lib/aws-sdk-b2bi/plugins/endpoints.rb +122 -0
- data/lib/aws-sdk-b2bi/resource.rb +26 -0
- data/lib/aws-sdk-b2bi/types.rb +2051 -0
- data/lib/aws-sdk-b2bi.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,2577 @@
|
|
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.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
35
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
36
|
+
|
37
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:b2bi)
|
38
|
+
|
39
|
+
module Aws::B2bi
|
40
|
+
# An API client for B2bi. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::B2bi::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 = :b2bi
|
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::JsonvalueConverter)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
78
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
79
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
85
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
86
|
+
add_plugin(Aws::B2bi::Plugins::Endpoints)
|
87
|
+
|
88
|
+
# @overload initialize(options)
|
89
|
+
# @param [Hash] options
|
90
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
91
|
+
# Your AWS credentials. This can be an instance of any one of the
|
92
|
+
# following classes:
|
93
|
+
#
|
94
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
95
|
+
# credentials.
|
96
|
+
#
|
97
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
98
|
+
# shared file, such as `~/.aws/config`.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
101
|
+
#
|
102
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
103
|
+
# assume a role after providing credentials via the web.
|
104
|
+
#
|
105
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
106
|
+
# access token generated from `aws login`.
|
107
|
+
#
|
108
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
109
|
+
# process that outputs to stdout.
|
110
|
+
#
|
111
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
112
|
+
# from an EC2 IMDS on an EC2 instance.
|
113
|
+
#
|
114
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
115
|
+
# instances running in ECS.
|
116
|
+
#
|
117
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
118
|
+
# from the Cognito Identity service.
|
119
|
+
#
|
120
|
+
# When `:credentials` are not configured directly, the following
|
121
|
+
# locations will be searched for credentials:
|
122
|
+
#
|
123
|
+
# * `Aws.config[:credentials]`
|
124
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
125
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
126
|
+
# * `~/.aws/credentials`
|
127
|
+
# * `~/.aws/config`
|
128
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
129
|
+
# are very aggressive. Construct and pass an instance of
|
130
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
131
|
+
# enable retries and extended timeouts. Instance profile credential
|
132
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
133
|
+
# to true.
|
134
|
+
#
|
135
|
+
# @option options [required, String] :region
|
136
|
+
# The AWS region to connect to. The configured `:region` is
|
137
|
+
# used to determine the service `:endpoint`. When not passed,
|
138
|
+
# a default `:region` is searched for in the following locations:
|
139
|
+
#
|
140
|
+
# * `Aws.config[:region]`
|
141
|
+
# * `ENV['AWS_REGION']`
|
142
|
+
# * `ENV['AMAZON_REGION']`
|
143
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
144
|
+
# * `~/.aws/credentials`
|
145
|
+
# * `~/.aws/config`
|
146
|
+
#
|
147
|
+
# @option options [String] :access_key_id
|
148
|
+
#
|
149
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
150
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
151
|
+
# the background every 60 secs (default). Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
154
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
155
|
+
# until there is sufficent client side capacity to retry the request.
|
156
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
157
|
+
# not retry instead of sleeping.
|
158
|
+
#
|
159
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
160
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
161
|
+
# this client.
|
162
|
+
#
|
163
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
164
|
+
# Allows you to provide an identifier for this client which will be attached to
|
165
|
+
# all generated client side metrics. Defaults to an empty string.
|
166
|
+
#
|
167
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
168
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
169
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
170
|
+
#
|
171
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
172
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
173
|
+
# agent is running on, where client metrics will be published via UDP.
|
174
|
+
#
|
175
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
176
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
177
|
+
# will use the Client Side Monitoring Agent Publisher.
|
178
|
+
#
|
179
|
+
# @option options [Boolean] :convert_params (true)
|
180
|
+
# When `true`, an attempt is made to coerce request parameters into
|
181
|
+
# the required types.
|
182
|
+
#
|
183
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
184
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
185
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
186
|
+
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
191
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
192
|
+
# Set to true to disable SDK automatically adding host prefix
|
193
|
+
# to default service endpoint when available.
|
194
|
+
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
199
|
+
# @option options [String] :endpoint
|
200
|
+
# The client endpoint is normally constructed from the `:region`
|
201
|
+
# option. You should only configure an `:endpoint` when connecting
|
202
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
203
|
+
#
|
204
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
206
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
207
|
+
#
|
208
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
209
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
210
|
+
#
|
211
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
212
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
213
|
+
# Use this option to config the time interval in seconds for making
|
214
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
215
|
+
#
|
216
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
217
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
218
|
+
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
223
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
224
|
+
# The log formatter.
|
225
|
+
#
|
226
|
+
# @option options [Symbol] :log_level (:info)
|
227
|
+
# The log level to send messages to the `:logger` at.
|
228
|
+
#
|
229
|
+
# @option options [Logger] :logger
|
230
|
+
# The Logger instance to send log messages to. If this option
|
231
|
+
# is not set, logging will be disabled.
|
232
|
+
#
|
233
|
+
# @option options [Integer] :max_attempts (3)
|
234
|
+
# An integer representing the maximum number attempts that will be made for
|
235
|
+
# a single request, including the initial attempt. For example,
|
236
|
+
# setting this value to 5 will result in a request being retried up to
|
237
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
238
|
+
#
|
239
|
+
# @option options [String] :profile ("default")
|
240
|
+
# Used when loading credentials from the shared credentials file
|
241
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
242
|
+
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
248
|
+
# @option options [Proc] :retry_backoff
|
249
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
250
|
+
# This option is only used in the `legacy` retry mode.
|
251
|
+
#
|
252
|
+
# @option options [Float] :retry_base_delay (0.3)
|
253
|
+
# The base delay in seconds used by the default backoff function. This option
|
254
|
+
# is only used in the `legacy` retry mode.
|
255
|
+
#
|
256
|
+
# @option options [Symbol] :retry_jitter (:none)
|
257
|
+
# A delay randomiser function used by the default backoff function.
|
258
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
259
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
260
|
+
# in the `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
263
|
+
#
|
264
|
+
# @option options [Integer] :retry_limit (3)
|
265
|
+
# The maximum number of times to retry failed requests. Only
|
266
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
267
|
+
# are retried. Generally, these are throttling errors, data
|
268
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
269
|
+
# endpoint discovery, and errors from expired credentials.
|
270
|
+
# This option is only used in the `legacy` retry mode.
|
271
|
+
#
|
272
|
+
# @option options [Integer] :retry_max_delay (0)
|
273
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
274
|
+
# used by the default backoff function. This option is only used in the
|
275
|
+
# `legacy` retry mode.
|
276
|
+
#
|
277
|
+
# @option options [String] :retry_mode ("legacy")
|
278
|
+
# Specifies which retry algorithm to use. Values are:
|
279
|
+
#
|
280
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
281
|
+
# no retry mode is provided.
|
282
|
+
#
|
283
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
284
|
+
# This includes support for retry quotas, which limit the number of
|
285
|
+
# unsuccessful retries a client can make.
|
286
|
+
#
|
287
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
288
|
+
# functionality of `standard` mode along with automatic client side
|
289
|
+
# throttling. This is a provisional mode that may change behavior
|
290
|
+
# in the future.
|
291
|
+
#
|
292
|
+
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
298
|
+
# @option options [String] :secret_access_key
|
299
|
+
#
|
300
|
+
# @option options [String] :session_token
|
301
|
+
#
|
302
|
+
# @option options [Boolean] :simple_json (false)
|
303
|
+
# Disables request parameter conversion, validation, and formatting.
|
304
|
+
# Also disable response data type conversions. This option is useful
|
305
|
+
# when you want to ensure the highest level of performance by
|
306
|
+
# avoiding overhead of walking request parameters and response data
|
307
|
+
# structures.
|
308
|
+
#
|
309
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
310
|
+
# be formatted exactly as the DynamoDB API expects.
|
311
|
+
#
|
312
|
+
# @option options [Boolean] :stub_responses (false)
|
313
|
+
# Causes the client to return stubbed responses. By default
|
314
|
+
# fake responses are generated and returned. You can specify
|
315
|
+
# the response data to return or errors to raise by calling
|
316
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
317
|
+
#
|
318
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
319
|
+
# requests are made, and retries are disabled.
|
320
|
+
#
|
321
|
+
# @option options [Aws::TokenProvider] :token_provider
|
322
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
323
|
+
# following classes:
|
324
|
+
#
|
325
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
326
|
+
# tokens.
|
327
|
+
#
|
328
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
329
|
+
# access token generated from `aws login`.
|
330
|
+
#
|
331
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
332
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
333
|
+
#
|
334
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
335
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
336
|
+
# will be used if available.
|
337
|
+
#
|
338
|
+
# @option options [Boolean] :use_fips_endpoint
|
339
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
340
|
+
# When a `fips` region is used, the region is normalized and this config
|
341
|
+
# is set to `true`.
|
342
|
+
#
|
343
|
+
# @option options [Boolean] :validate_params (true)
|
344
|
+
# When `true`, request parameters are validated before
|
345
|
+
# sending the request.
|
346
|
+
#
|
347
|
+
# @option options [Aws::B2bi::EndpointProvider] :endpoint_provider
|
348
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::B2bi::EndpointParameters`
|
349
|
+
#
|
350
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
351
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
352
|
+
#
|
353
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
354
|
+
# seconds to wait when opening a HTTP session before raising a
|
355
|
+
# `Timeout::Error`.
|
356
|
+
#
|
357
|
+
# @option options [Float] :http_read_timeout (60) The default
|
358
|
+
# number of seconds to wait for response data. This value can
|
359
|
+
# safely be set per-request on the session.
|
360
|
+
#
|
361
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
362
|
+
# seconds a connection is allowed to sit idle before it is
|
363
|
+
# considered stale. Stale connections are closed and removed
|
364
|
+
# from the pool before making a request.
|
365
|
+
#
|
366
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
367
|
+
# seconds to wait for a 100-continue response before sending the
|
368
|
+
# request body. This option has no effect unless the request has
|
369
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
370
|
+
# disables this behaviour. This value can safely be set per
|
371
|
+
# request on the session.
|
372
|
+
#
|
373
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
374
|
+
# in seconds.
|
375
|
+
#
|
376
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
377
|
+
# HTTP debug output will be sent to the `:logger`.
|
378
|
+
#
|
379
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
380
|
+
# SSL peer certificates are verified when establishing a
|
381
|
+
# connection.
|
382
|
+
#
|
383
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
384
|
+
# certificate authority bundle file that should be used when
|
385
|
+
# verifying peer certificates. If you do not pass
|
386
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
387
|
+
# will be used if available.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
390
|
+
# directory that contains the unbundled SSL certificate
|
391
|
+
# authority files for verifying peer certificates. If you do
|
392
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
393
|
+
# system default will be used if available.
|
394
|
+
#
|
395
|
+
def initialize(*args)
|
396
|
+
super
|
397
|
+
end
|
398
|
+
|
399
|
+
# @!group API Operations
|
400
|
+
|
401
|
+
# Instantiates a capability based on the specified parameters.
|
402
|
+
# Capabilities contain the information necessary to process incoming EDI
|
403
|
+
# (electronic data interchange) documents.
|
404
|
+
#
|
405
|
+
# @option params [required, String] :name
|
406
|
+
# Specifies the name of the capability, used to identify it.
|
407
|
+
#
|
408
|
+
# @option params [required, String] :type
|
409
|
+
# Specifies the type of the capability. Currently, only `edi` is
|
410
|
+
# supported.
|
411
|
+
#
|
412
|
+
# @option params [required, Types::CapabilityConfiguration] :configuration
|
413
|
+
# Specifies a structure that contains the details for a capability.
|
414
|
+
#
|
415
|
+
# @option params [Array<Types::S3Location>] :instructions_documents
|
416
|
+
# Specifies one or more locations in Amazon S3, each specifying an EDI
|
417
|
+
# document that can be used with this capability. Each item contains the
|
418
|
+
# name of the bucket and the key, to identify the document's location.
|
419
|
+
#
|
420
|
+
# @option params [String] :client_token
|
421
|
+
# Reserved for future use.
|
422
|
+
#
|
423
|
+
# **A suitable default value is auto-generated.** You should normally
|
424
|
+
# not need to pass this option.**
|
425
|
+
#
|
426
|
+
# @option params [Array<Types::Tag>] :tags
|
427
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
428
|
+
# group and search for resources by type. You can attach this metadata
|
429
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
430
|
+
#
|
431
|
+
# @return [Types::CreateCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
432
|
+
#
|
433
|
+
# * {Types::CreateCapabilityResponse#capability_id #capability_id} => String
|
434
|
+
# * {Types::CreateCapabilityResponse#capability_arn #capability_arn} => String
|
435
|
+
# * {Types::CreateCapabilityResponse#name #name} => String
|
436
|
+
# * {Types::CreateCapabilityResponse#type #type} => String
|
437
|
+
# * {Types::CreateCapabilityResponse#configuration #configuration} => Types::CapabilityConfiguration
|
438
|
+
# * {Types::CreateCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location>
|
439
|
+
# * {Types::CreateCapabilityResponse#created_at #created_at} => Time
|
440
|
+
#
|
441
|
+
#
|
442
|
+
# @example Example: Sample CreateCapability call
|
443
|
+
#
|
444
|
+
# resp = client.create_capability({
|
445
|
+
# name: "b2biexample",
|
446
|
+
# type: "edi",
|
447
|
+
# client_token: "foo",
|
448
|
+
# configuration: {
|
449
|
+
# edi: {
|
450
|
+
# type: {
|
451
|
+
# x12_details: {
|
452
|
+
# version: "VERSION_4010",
|
453
|
+
# transaction_set: "X12_110",
|
454
|
+
# },
|
455
|
+
# },
|
456
|
+
# input_location: {
|
457
|
+
# key: "input/",
|
458
|
+
# bucket_name: "test-bucket",
|
459
|
+
# },
|
460
|
+
# output_location: {
|
461
|
+
# key: "output/",
|
462
|
+
# bucket_name: "test-bucket",
|
463
|
+
# },
|
464
|
+
# transformer_id: "tr-9a893cf536df4658b",
|
465
|
+
# },
|
466
|
+
# },
|
467
|
+
# instructions_documents: [
|
468
|
+
# {
|
469
|
+
# key: "instructiondoc.txt",
|
470
|
+
# bucket_name: "test-bucket",
|
471
|
+
# },
|
472
|
+
# ],
|
473
|
+
# tags: [
|
474
|
+
# {
|
475
|
+
# key: "capabilityKey1",
|
476
|
+
# value: "capabilityValue1",
|
477
|
+
# },
|
478
|
+
# ],
|
479
|
+
# })
|
480
|
+
#
|
481
|
+
# resp.to_h outputs the following:
|
482
|
+
# {
|
483
|
+
# name: "b2biexample",
|
484
|
+
# type: "edi",
|
485
|
+
# capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
|
486
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
487
|
+
# configuration: {
|
488
|
+
# edi: {
|
489
|
+
# type: {
|
490
|
+
# x12_details: {
|
491
|
+
# version: "VERSION_4010",
|
492
|
+
# transaction_set: "X12_110",
|
493
|
+
# },
|
494
|
+
# },
|
495
|
+
# input_location: {
|
496
|
+
# key: "input/",
|
497
|
+
# bucket_name: "test-bucket",
|
498
|
+
# },
|
499
|
+
# output_location: {
|
500
|
+
# key: "output/",
|
501
|
+
# bucket_name: "test-bucket",
|
502
|
+
# },
|
503
|
+
# transformer_id: "tr-9a893cf536df4658b",
|
504
|
+
# },
|
505
|
+
# },
|
506
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
507
|
+
# instructions_documents: [
|
508
|
+
# {
|
509
|
+
# key: "instructiondoc.txt",
|
510
|
+
# bucket_name: "test-bucket",
|
511
|
+
# },
|
512
|
+
# ],
|
513
|
+
# }
|
514
|
+
#
|
515
|
+
# @example Request syntax with placeholder values
|
516
|
+
#
|
517
|
+
# resp = client.create_capability({
|
518
|
+
# name: "CapabilityName", # required
|
519
|
+
# type: "edi", # required, accepts edi
|
520
|
+
# configuration: { # required
|
521
|
+
# edi: {
|
522
|
+
# type: { # required
|
523
|
+
# x12_details: {
|
524
|
+
# transaction_set: "X12_110", # accepts X12_110, X12_180, X12_204, X12_210, X12_214, X12_215, X12_310, X12_315, X12_322, X12_404, X12_410, X12_820, X12_824, X12_830, X12_846, X12_850, X12_852, X12_855, X12_856, X12_860, X12_861, X12_864, X12_940, X12_990, X12_997
|
525
|
+
# version: "VERSION_4010", # accepts VERSION_4010, VERSION_4030, VERSION_5010
|
526
|
+
# },
|
527
|
+
# },
|
528
|
+
# input_location: { # required
|
529
|
+
# bucket_name: "BucketName",
|
530
|
+
# key: "S3Key",
|
531
|
+
# },
|
532
|
+
# output_location: { # required
|
533
|
+
# bucket_name: "BucketName",
|
534
|
+
# key: "S3Key",
|
535
|
+
# },
|
536
|
+
# transformer_id: "TransformerId", # required
|
537
|
+
# },
|
538
|
+
# },
|
539
|
+
# instructions_documents: [
|
540
|
+
# {
|
541
|
+
# bucket_name: "BucketName",
|
542
|
+
# key: "S3Key",
|
543
|
+
# },
|
544
|
+
# ],
|
545
|
+
# client_token: "String",
|
546
|
+
# tags: [
|
547
|
+
# {
|
548
|
+
# key: "TagKey", # required
|
549
|
+
# value: "TagValue", # required
|
550
|
+
# },
|
551
|
+
# ],
|
552
|
+
# })
|
553
|
+
#
|
554
|
+
# @example Response structure
|
555
|
+
#
|
556
|
+
# resp.capability_id #=> String
|
557
|
+
# resp.capability_arn #=> String
|
558
|
+
# resp.name #=> String
|
559
|
+
# resp.type #=> String, one of "edi"
|
560
|
+
# resp.configuration.edi.type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
561
|
+
# resp.configuration.edi.type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
562
|
+
# resp.configuration.edi.input_location.bucket_name #=> String
|
563
|
+
# resp.configuration.edi.input_location.key #=> String
|
564
|
+
# resp.configuration.edi.output_location.bucket_name #=> String
|
565
|
+
# resp.configuration.edi.output_location.key #=> String
|
566
|
+
# resp.configuration.edi.transformer_id #=> String
|
567
|
+
# resp.instructions_documents #=> Array
|
568
|
+
# resp.instructions_documents[0].bucket_name #=> String
|
569
|
+
# resp.instructions_documents[0].key #=> String
|
570
|
+
# resp.created_at #=> Time
|
571
|
+
#
|
572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateCapability AWS API Documentation
|
573
|
+
#
|
574
|
+
# @overload create_capability(params = {})
|
575
|
+
# @param [Hash] params ({})
|
576
|
+
def create_capability(params = {}, options = {})
|
577
|
+
req = build_request(:create_capability, params)
|
578
|
+
req.send_request(options)
|
579
|
+
end
|
580
|
+
|
581
|
+
# Creates a partnership between a customer and a trading partner, based
|
582
|
+
# on the supplied parameters. Partnerships link trading partners with
|
583
|
+
# your profile and a specific transformer, so that the EDI (electronic
|
584
|
+
# data interchange) documents that they upload to Amazon S3 can be
|
585
|
+
# processed according to their specifications.
|
586
|
+
#
|
587
|
+
# @option params [required, String] :profile_id
|
588
|
+
# Specifies the unique, system-generated identifier for the profile
|
589
|
+
# connected to this partnership.
|
590
|
+
#
|
591
|
+
# @option params [required, String] :name
|
592
|
+
# Specifies a descriptive name for the partnership.
|
593
|
+
#
|
594
|
+
# @option params [required, String] :email
|
595
|
+
# Specifies the email address associated with this trading partner.
|
596
|
+
#
|
597
|
+
# @option params [String] :phone
|
598
|
+
# Specifies the phone number associated with the partnership.
|
599
|
+
#
|
600
|
+
# @option params [Array<String>] :capabilities
|
601
|
+
# Specifies a list of the capabilities associated with this partnership.
|
602
|
+
#
|
603
|
+
# @option params [String] :client_token
|
604
|
+
# Reserved for future use.
|
605
|
+
#
|
606
|
+
# **A suitable default value is auto-generated.** You should normally
|
607
|
+
# not need to pass this option.**
|
608
|
+
#
|
609
|
+
# @option params [Array<Types::Tag>] :tags
|
610
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
611
|
+
# group and search for resources by type. You can attach this metadata
|
612
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
613
|
+
#
|
614
|
+
# @return [Types::CreatePartnershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
615
|
+
#
|
616
|
+
# * {Types::CreatePartnershipResponse#profile_id #profile_id} => String
|
617
|
+
# * {Types::CreatePartnershipResponse#partnership_id #partnership_id} => String
|
618
|
+
# * {Types::CreatePartnershipResponse#partnership_arn #partnership_arn} => String
|
619
|
+
# * {Types::CreatePartnershipResponse#name #name} => String
|
620
|
+
# * {Types::CreatePartnershipResponse#email #email} => String
|
621
|
+
# * {Types::CreatePartnershipResponse#phone #phone} => String
|
622
|
+
# * {Types::CreatePartnershipResponse#capabilities #capabilities} => Array<String>
|
623
|
+
# * {Types::CreatePartnershipResponse#trading_partner_id #trading_partner_id} => String
|
624
|
+
# * {Types::CreatePartnershipResponse#created_at #created_at} => Time
|
625
|
+
#
|
626
|
+
#
|
627
|
+
# @example Example: Sample CreatePartnership call
|
628
|
+
#
|
629
|
+
# resp = client.create_partnership({
|
630
|
+
# name: "b2bipartner",
|
631
|
+
# capabilities: [
|
632
|
+
# "ca-963a8121e4fc4e348",
|
633
|
+
# ],
|
634
|
+
# client_token: "foo",
|
635
|
+
# email: "john@example.com",
|
636
|
+
# phone: "5555555555",
|
637
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
638
|
+
# tags: [
|
639
|
+
# {
|
640
|
+
# key: "sampleKey1",
|
641
|
+
# value: "sampleValue1",
|
642
|
+
# },
|
643
|
+
# ],
|
644
|
+
# })
|
645
|
+
#
|
646
|
+
# resp.to_h outputs the following:
|
647
|
+
# {
|
648
|
+
# name: "b2bipartner",
|
649
|
+
# capabilities: [
|
650
|
+
# "ca-963a8121e4fc4e348",
|
651
|
+
# ],
|
652
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
653
|
+
# email: "john@example.com",
|
654
|
+
# partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
|
655
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
656
|
+
# phone: "5555555555",
|
657
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
658
|
+
# trading_partner_id: "tp-2a17ca447f6f4a8a8",
|
659
|
+
# }
|
660
|
+
#
|
661
|
+
# @example Request syntax with placeholder values
|
662
|
+
#
|
663
|
+
# resp = client.create_partnership({
|
664
|
+
# profile_id: "ProfileId", # required
|
665
|
+
# name: "PartnerName", # required
|
666
|
+
# email: "Email", # required
|
667
|
+
# phone: "Phone",
|
668
|
+
# capabilities: ["CapabilityId"],
|
669
|
+
# client_token: "String",
|
670
|
+
# tags: [
|
671
|
+
# {
|
672
|
+
# key: "TagKey", # required
|
673
|
+
# value: "TagValue", # required
|
674
|
+
# },
|
675
|
+
# ],
|
676
|
+
# })
|
677
|
+
#
|
678
|
+
# @example Response structure
|
679
|
+
#
|
680
|
+
# resp.profile_id #=> String
|
681
|
+
# resp.partnership_id #=> String
|
682
|
+
# resp.partnership_arn #=> String
|
683
|
+
# resp.name #=> String
|
684
|
+
# resp.email #=> String
|
685
|
+
# resp.phone #=> String
|
686
|
+
# resp.capabilities #=> Array
|
687
|
+
# resp.capabilities[0] #=> String
|
688
|
+
# resp.trading_partner_id #=> String
|
689
|
+
# resp.created_at #=> Time
|
690
|
+
#
|
691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreatePartnership AWS API Documentation
|
692
|
+
#
|
693
|
+
# @overload create_partnership(params = {})
|
694
|
+
# @param [Hash] params ({})
|
695
|
+
def create_partnership(params = {}, options = {})
|
696
|
+
req = build_request(:create_partnership, params)
|
697
|
+
req.send_request(options)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Creates a customer profile. You can have up to five customer profiles,
|
701
|
+
# each representing a distinct private network. Profiles contain basic
|
702
|
+
# information about you and your business.
|
703
|
+
#
|
704
|
+
# @option params [required, String] :name
|
705
|
+
# Specifies the name of the profile.
|
706
|
+
#
|
707
|
+
# @option params [String] :email
|
708
|
+
# Specifies the email address associated with this customer profile.
|
709
|
+
#
|
710
|
+
# @option params [required, String] :phone
|
711
|
+
# Specifies the phone number associated with the profile.
|
712
|
+
#
|
713
|
+
# @option params [required, String] :business_name
|
714
|
+
# Specifies the name for the business associated with this profile.
|
715
|
+
#
|
716
|
+
# @option params [required, String] :logging
|
717
|
+
# Specifies whether or not logging is enabled for this profile.
|
718
|
+
#
|
719
|
+
# @option params [String] :client_token
|
720
|
+
# Reserved for future use.
|
721
|
+
#
|
722
|
+
# **A suitable default value is auto-generated.** You should normally
|
723
|
+
# not need to pass this option.**
|
724
|
+
#
|
725
|
+
# @option params [Array<Types::Tag>] :tags
|
726
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
727
|
+
# group and search for resources by type. You can attach this metadata
|
728
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
729
|
+
#
|
730
|
+
# @return [Types::CreateProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
731
|
+
#
|
732
|
+
# * {Types::CreateProfileResponse#profile_id #profile_id} => String
|
733
|
+
# * {Types::CreateProfileResponse#profile_arn #profile_arn} => String
|
734
|
+
# * {Types::CreateProfileResponse#name #name} => String
|
735
|
+
# * {Types::CreateProfileResponse#business_name #business_name} => String
|
736
|
+
# * {Types::CreateProfileResponse#phone #phone} => String
|
737
|
+
# * {Types::CreateProfileResponse#email #email} => String
|
738
|
+
# * {Types::CreateProfileResponse#logging #logging} => String
|
739
|
+
# * {Types::CreateProfileResponse#log_group_name #log_group_name} => String
|
740
|
+
# * {Types::CreateProfileResponse#created_at #created_at} => Time
|
741
|
+
#
|
742
|
+
#
|
743
|
+
# @example Example: Sample CreateProfile call
|
744
|
+
#
|
745
|
+
# resp = client.create_profile({
|
746
|
+
# name: "Shipping Profile",
|
747
|
+
# business_name: "John's Shipping",
|
748
|
+
# client_token: "foo",
|
749
|
+
# email: "john@example.com",
|
750
|
+
# logging: "ENABLED",
|
751
|
+
# phone: "5555555555",
|
752
|
+
# tags: [
|
753
|
+
# {
|
754
|
+
# key: "sampleKey",
|
755
|
+
# value: "sampleValue",
|
756
|
+
# },
|
757
|
+
# ],
|
758
|
+
# })
|
759
|
+
#
|
760
|
+
# resp.to_h outputs the following:
|
761
|
+
# {
|
762
|
+
# name: "Shipping Profile",
|
763
|
+
# business_name: "John's Trucking",
|
764
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
765
|
+
# email: "john@example.com",
|
766
|
+
# log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
|
767
|
+
# logging: "ENABLED",
|
768
|
+
# phone: "5555555555",
|
769
|
+
# profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
770
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
771
|
+
# }
|
772
|
+
#
|
773
|
+
# @example Request syntax with placeholder values
|
774
|
+
#
|
775
|
+
# resp = client.create_profile({
|
776
|
+
# name: "ProfileName", # required
|
777
|
+
# email: "Email",
|
778
|
+
# phone: "Phone", # required
|
779
|
+
# business_name: "BusinessName", # required
|
780
|
+
# logging: "ENABLED", # required, accepts ENABLED, DISABLED
|
781
|
+
# client_token: "String",
|
782
|
+
# tags: [
|
783
|
+
# {
|
784
|
+
# key: "TagKey", # required
|
785
|
+
# value: "TagValue", # required
|
786
|
+
# },
|
787
|
+
# ],
|
788
|
+
# })
|
789
|
+
#
|
790
|
+
# @example Response structure
|
791
|
+
#
|
792
|
+
# resp.profile_id #=> String
|
793
|
+
# resp.profile_arn #=> String
|
794
|
+
# resp.name #=> String
|
795
|
+
# resp.business_name #=> String
|
796
|
+
# resp.phone #=> String
|
797
|
+
# resp.email #=> String
|
798
|
+
# resp.logging #=> String, one of "ENABLED", "DISABLED"
|
799
|
+
# resp.log_group_name #=> String
|
800
|
+
# resp.created_at #=> Time
|
801
|
+
#
|
802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateProfile AWS API Documentation
|
803
|
+
#
|
804
|
+
# @overload create_profile(params = {})
|
805
|
+
# @param [Hash] params ({})
|
806
|
+
def create_profile(params = {}, options = {})
|
807
|
+
req = build_request(:create_profile, params)
|
808
|
+
req.send_request(options)
|
809
|
+
end
|
810
|
+
|
811
|
+
# Creates a transformer. Transformers describe how to process the
|
812
|
+
# incoming EDI (electronic data interchange) documents, and extract the
|
813
|
+
# necessary information.
|
814
|
+
#
|
815
|
+
# @option params [required, String] :name
|
816
|
+
# Specifies the name of the transformer, used to identify it.
|
817
|
+
#
|
818
|
+
# @option params [required, String] :file_format
|
819
|
+
# Specifies that the currently supported file formats for EDI
|
820
|
+
# transformations are `JSON` and `XML`.
|
821
|
+
#
|
822
|
+
# @option params [required, String] :mapping_template
|
823
|
+
# Specifies the name of the mapping template for the transformer. This
|
824
|
+
# template is used to convert the input document into the correct set of
|
825
|
+
# objects.
|
826
|
+
#
|
827
|
+
# @option params [required, Types::EdiType] :edi_type
|
828
|
+
# Specifies the details for the EDI standard that is being used for the
|
829
|
+
# transformer. Currently, only X12 is supported. X12 is a set of
|
830
|
+
# standards and corresponding messages that define specific business
|
831
|
+
# documents.
|
832
|
+
#
|
833
|
+
# @option params [String] :sample_document
|
834
|
+
# Specifies a sample EDI document that is used by a transformer as a
|
835
|
+
# guide for processing the EDI data.
|
836
|
+
#
|
837
|
+
# @option params [String] :client_token
|
838
|
+
# Reserved for future use.
|
839
|
+
#
|
840
|
+
# **A suitable default value is auto-generated.** You should normally
|
841
|
+
# not need to pass this option.**
|
842
|
+
#
|
843
|
+
# @option params [Array<Types::Tag>] :tags
|
844
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
845
|
+
# group and search for resources by type. You can attach this metadata
|
846
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
847
|
+
#
|
848
|
+
# @return [Types::CreateTransformerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
849
|
+
#
|
850
|
+
# * {Types::CreateTransformerResponse#transformer_id #transformer_id} => String
|
851
|
+
# * {Types::CreateTransformerResponse#transformer_arn #transformer_arn} => String
|
852
|
+
# * {Types::CreateTransformerResponse#name #name} => String
|
853
|
+
# * {Types::CreateTransformerResponse#file_format #file_format} => String
|
854
|
+
# * {Types::CreateTransformerResponse#mapping_template #mapping_template} => String
|
855
|
+
# * {Types::CreateTransformerResponse#status #status} => String
|
856
|
+
# * {Types::CreateTransformerResponse#edi_type #edi_type} => Types::EdiType
|
857
|
+
# * {Types::CreateTransformerResponse#sample_document #sample_document} => String
|
858
|
+
# * {Types::CreateTransformerResponse#created_at #created_at} => Time
|
859
|
+
#
|
860
|
+
#
|
861
|
+
# @example Example: Sample CreateTransformer call
|
862
|
+
#
|
863
|
+
# resp = client.create_transformer({
|
864
|
+
# name: "transformJSON",
|
865
|
+
# client_token: "foo",
|
866
|
+
# edi_type: {
|
867
|
+
# x12_details: {
|
868
|
+
# version: "VERSION_4010",
|
869
|
+
# transaction_set: "X12_110",
|
870
|
+
# },
|
871
|
+
# },
|
872
|
+
# file_format: "JSON",
|
873
|
+
# mapping_template: "{}",
|
874
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
875
|
+
# tags: [
|
876
|
+
# {
|
877
|
+
# key: "sampleKey",
|
878
|
+
# value: "sampleValue",
|
879
|
+
# },
|
880
|
+
# ],
|
881
|
+
# })
|
882
|
+
#
|
883
|
+
# resp.to_h outputs the following:
|
884
|
+
# {
|
885
|
+
# name: "transformJSON",
|
886
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
887
|
+
# edi_type: {
|
888
|
+
# x12_details: {
|
889
|
+
# version: "VERSION_4010",
|
890
|
+
# transaction_set: "X12_110",
|
891
|
+
# },
|
892
|
+
# },
|
893
|
+
# file_format: "JSON",
|
894
|
+
# mapping_template: "$",
|
895
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
896
|
+
# status: "inactive",
|
897
|
+
# transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
|
898
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
899
|
+
# }
|
900
|
+
#
|
901
|
+
# @example Request syntax with placeholder values
|
902
|
+
#
|
903
|
+
# resp = client.create_transformer({
|
904
|
+
# name: "TransformerName", # required
|
905
|
+
# file_format: "XML", # required, accepts XML, JSON
|
906
|
+
# mapping_template: "MappingTemplate", # required
|
907
|
+
# edi_type: { # required
|
908
|
+
# x12_details: {
|
909
|
+
# transaction_set: "X12_110", # accepts X12_110, X12_180, X12_204, X12_210, X12_214, X12_215, X12_310, X12_315, X12_322, X12_404, X12_410, X12_820, X12_824, X12_830, X12_846, X12_850, X12_852, X12_855, X12_856, X12_860, X12_861, X12_864, X12_940, X12_990, X12_997
|
910
|
+
# version: "VERSION_4010", # accepts VERSION_4010, VERSION_4030, VERSION_5010
|
911
|
+
# },
|
912
|
+
# },
|
913
|
+
# sample_document: "FileLocation",
|
914
|
+
# client_token: "String",
|
915
|
+
# tags: [
|
916
|
+
# {
|
917
|
+
# key: "TagKey", # required
|
918
|
+
# value: "TagValue", # required
|
919
|
+
# },
|
920
|
+
# ],
|
921
|
+
# })
|
922
|
+
#
|
923
|
+
# @example Response structure
|
924
|
+
#
|
925
|
+
# resp.transformer_id #=> String
|
926
|
+
# resp.transformer_arn #=> String
|
927
|
+
# resp.name #=> String
|
928
|
+
# resp.file_format #=> String, one of "XML", "JSON"
|
929
|
+
# resp.mapping_template #=> String
|
930
|
+
# resp.status #=> String, one of "active", "inactive"
|
931
|
+
# resp.edi_type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
932
|
+
# resp.edi_type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
933
|
+
# resp.sample_document #=> String
|
934
|
+
# resp.created_at #=> Time
|
935
|
+
#
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateTransformer AWS API Documentation
|
937
|
+
#
|
938
|
+
# @overload create_transformer(params = {})
|
939
|
+
# @param [Hash] params ({})
|
940
|
+
def create_transformer(params = {}, options = {})
|
941
|
+
req = build_request(:create_transformer, params)
|
942
|
+
req.send_request(options)
|
943
|
+
end
|
944
|
+
|
945
|
+
# Deletes the specified capability. Capabilities contain the information
|
946
|
+
# necessary to process incoming EDI (electronic data interchange)
|
947
|
+
# documents.
|
948
|
+
#
|
949
|
+
# @option params [required, String] :capability_id
|
950
|
+
# Specifies a system-assigned unique identifier for the capability.
|
951
|
+
#
|
952
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
953
|
+
#
|
954
|
+
#
|
955
|
+
# @example Example: Sample DeleteCapabilty call
|
956
|
+
#
|
957
|
+
# resp = client.delete_capability({
|
958
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @example Request syntax with placeholder values
|
962
|
+
#
|
963
|
+
# resp = client.delete_capability({
|
964
|
+
# capability_id: "CapabilityId", # required
|
965
|
+
# })
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteCapability AWS API Documentation
|
968
|
+
#
|
969
|
+
# @overload delete_capability(params = {})
|
970
|
+
# @param [Hash] params ({})
|
971
|
+
def delete_capability(params = {}, options = {})
|
972
|
+
req = build_request(:delete_capability, params)
|
973
|
+
req.send_request(options)
|
974
|
+
end
|
975
|
+
|
976
|
+
# Deletes the specified partnership. Partnerships link trading partners
|
977
|
+
# with your profile and a specific transformer, so that the EDI
|
978
|
+
# (electronic data interchange) documents that they upload to Amazon S3
|
979
|
+
# can be processed according to their specifications.
|
980
|
+
#
|
981
|
+
# @option params [required, String] :partnership_id
|
982
|
+
# Specifies the unique, system-generated identifier for a partnership.
|
983
|
+
#
|
984
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
985
|
+
#
|
986
|
+
#
|
987
|
+
# @example Example: Sample DeletePartnership call
|
988
|
+
#
|
989
|
+
# resp = client.delete_partnership({
|
990
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
991
|
+
# })
|
992
|
+
#
|
993
|
+
# @example Request syntax with placeholder values
|
994
|
+
#
|
995
|
+
# resp = client.delete_partnership({
|
996
|
+
# partnership_id: "PartnershipId", # required
|
997
|
+
# })
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeletePartnership AWS API Documentation
|
1000
|
+
#
|
1001
|
+
# @overload delete_partnership(params = {})
|
1002
|
+
# @param [Hash] params ({})
|
1003
|
+
def delete_partnership(params = {}, options = {})
|
1004
|
+
req = build_request(:delete_partnership, params)
|
1005
|
+
req.send_request(options)
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# Deletes the specified profile. Profiles contain basic information
|
1009
|
+
# about you and your business.
|
1010
|
+
#
|
1011
|
+
# @option params [required, String] :profile_id
|
1012
|
+
# Specifies the unique, system-generated identifier for the profile.
|
1013
|
+
#
|
1014
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1015
|
+
#
|
1016
|
+
#
|
1017
|
+
# @example Example: Sample DeleteProfile call
|
1018
|
+
#
|
1019
|
+
# resp = client.delete_profile({
|
1020
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1021
|
+
# })
|
1022
|
+
#
|
1023
|
+
# @example Request syntax with placeholder values
|
1024
|
+
#
|
1025
|
+
# resp = client.delete_profile({
|
1026
|
+
# profile_id: "ProfileId", # required
|
1027
|
+
# })
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteProfile AWS API Documentation
|
1030
|
+
#
|
1031
|
+
# @overload delete_profile(params = {})
|
1032
|
+
# @param [Hash] params ({})
|
1033
|
+
def delete_profile(params = {}, options = {})
|
1034
|
+
req = build_request(:delete_profile, params)
|
1035
|
+
req.send_request(options)
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# Deletes the specified transformer. Transformers describe how to
|
1039
|
+
# process the incoming EDI (electronic data interchange) documents, and
|
1040
|
+
# extract the necessary information.
|
1041
|
+
#
|
1042
|
+
# @option params [required, String] :transformer_id
|
1043
|
+
# Specifies the system-assigned unique identifier for the transformer.
|
1044
|
+
#
|
1045
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1046
|
+
#
|
1047
|
+
#
|
1048
|
+
# @example Example: Sample DeleteTransformer call
|
1049
|
+
#
|
1050
|
+
# resp = client.delete_transformer({
|
1051
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1052
|
+
# })
|
1053
|
+
#
|
1054
|
+
# @example Request syntax with placeholder values
|
1055
|
+
#
|
1056
|
+
# resp = client.delete_transformer({
|
1057
|
+
# transformer_id: "TransformerId", # required
|
1058
|
+
# })
|
1059
|
+
#
|
1060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteTransformer AWS API Documentation
|
1061
|
+
#
|
1062
|
+
# @overload delete_transformer(params = {})
|
1063
|
+
# @param [Hash] params ({})
|
1064
|
+
def delete_transformer(params = {}, options = {})
|
1065
|
+
req = build_request(:delete_transformer, params)
|
1066
|
+
req.send_request(options)
|
1067
|
+
end
|
1068
|
+
|
1069
|
+
# Retrieves the details for the specified capability. Capabilities
|
1070
|
+
# contain the information necessary to process incoming EDI (electronic
|
1071
|
+
# data interchange) documents.
|
1072
|
+
#
|
1073
|
+
# @option params [required, String] :capability_id
|
1074
|
+
# Specifies a system-assigned unique identifier for the capability.
|
1075
|
+
#
|
1076
|
+
# @return [Types::GetCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1077
|
+
#
|
1078
|
+
# * {Types::GetCapabilityResponse#capability_id #capability_id} => String
|
1079
|
+
# * {Types::GetCapabilityResponse#capability_arn #capability_arn} => String
|
1080
|
+
# * {Types::GetCapabilityResponse#name #name} => String
|
1081
|
+
# * {Types::GetCapabilityResponse#type #type} => String
|
1082
|
+
# * {Types::GetCapabilityResponse#configuration #configuration} => Types::CapabilityConfiguration
|
1083
|
+
# * {Types::GetCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location>
|
1084
|
+
# * {Types::GetCapabilityResponse#created_at #created_at} => Time
|
1085
|
+
# * {Types::GetCapabilityResponse#modified_at #modified_at} => Time
|
1086
|
+
#
|
1087
|
+
#
|
1088
|
+
# @example Example: Sample GetCapabilty call
|
1089
|
+
#
|
1090
|
+
# resp = client.get_capability({
|
1091
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
1092
|
+
# })
|
1093
|
+
#
|
1094
|
+
# resp.to_h outputs the following:
|
1095
|
+
# {
|
1096
|
+
# name: "b2biexample",
|
1097
|
+
# type: "edi",
|
1098
|
+
# capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
|
1099
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
1100
|
+
# configuration: {
|
1101
|
+
# edi: {
|
1102
|
+
# type: {
|
1103
|
+
# x12_details: {
|
1104
|
+
# version: "VERSION_4010",
|
1105
|
+
# transaction_set: "X12_110",
|
1106
|
+
# },
|
1107
|
+
# },
|
1108
|
+
# input_location: {
|
1109
|
+
# key: "input/",
|
1110
|
+
# bucket_name: "test-bucket",
|
1111
|
+
# },
|
1112
|
+
# output_location: {
|
1113
|
+
# key: "output/",
|
1114
|
+
# bucket_name: "test-bucket",
|
1115
|
+
# },
|
1116
|
+
# transformer_id: "tr-9a893cf536df4658b",
|
1117
|
+
# },
|
1118
|
+
# },
|
1119
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1120
|
+
# instructions_documents: [
|
1121
|
+
# {
|
1122
|
+
# key: "instructiondoc.txt",
|
1123
|
+
# bucket_name: "test-bucket",
|
1124
|
+
# },
|
1125
|
+
# ],
|
1126
|
+
# modified_at: Time.parse("2023-11-02T21:51:05.504Z"),
|
1127
|
+
# }
|
1128
|
+
#
|
1129
|
+
# @example Request syntax with placeholder values
|
1130
|
+
#
|
1131
|
+
# resp = client.get_capability({
|
1132
|
+
# capability_id: "CapabilityId", # required
|
1133
|
+
# })
|
1134
|
+
#
|
1135
|
+
# @example Response structure
|
1136
|
+
#
|
1137
|
+
# resp.capability_id #=> String
|
1138
|
+
# resp.capability_arn #=> String
|
1139
|
+
# resp.name #=> String
|
1140
|
+
# resp.type #=> String, one of "edi"
|
1141
|
+
# resp.configuration.edi.type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
1142
|
+
# resp.configuration.edi.type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
1143
|
+
# resp.configuration.edi.input_location.bucket_name #=> String
|
1144
|
+
# resp.configuration.edi.input_location.key #=> String
|
1145
|
+
# resp.configuration.edi.output_location.bucket_name #=> String
|
1146
|
+
# resp.configuration.edi.output_location.key #=> String
|
1147
|
+
# resp.configuration.edi.transformer_id #=> String
|
1148
|
+
# resp.instructions_documents #=> Array
|
1149
|
+
# resp.instructions_documents[0].bucket_name #=> String
|
1150
|
+
# resp.instructions_documents[0].key #=> String
|
1151
|
+
# resp.created_at #=> Time
|
1152
|
+
# resp.modified_at #=> Time
|
1153
|
+
#
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetCapability AWS API Documentation
|
1155
|
+
#
|
1156
|
+
# @overload get_capability(params = {})
|
1157
|
+
# @param [Hash] params ({})
|
1158
|
+
def get_capability(params = {}, options = {})
|
1159
|
+
req = build_request(:get_capability, params)
|
1160
|
+
req.send_request(options)
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
# Retrieves the details for a partnership, based on the partner and
|
1164
|
+
# profile IDs specified. Partnerships link trading partners with your
|
1165
|
+
# profile and a specific transformer, so that the EDI (electronic data
|
1166
|
+
# interchange) documents that they upload to Amazon S3 can be processed
|
1167
|
+
# according to their specifications.
|
1168
|
+
#
|
1169
|
+
# @option params [required, String] :partnership_id
|
1170
|
+
# Specifies the unique, system-generated identifier for a partnership.
|
1171
|
+
#
|
1172
|
+
# @return [Types::GetPartnershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1173
|
+
#
|
1174
|
+
# * {Types::GetPartnershipResponse#profile_id #profile_id} => String
|
1175
|
+
# * {Types::GetPartnershipResponse#partnership_id #partnership_id} => String
|
1176
|
+
# * {Types::GetPartnershipResponse#partnership_arn #partnership_arn} => String
|
1177
|
+
# * {Types::GetPartnershipResponse#name #name} => String
|
1178
|
+
# * {Types::GetPartnershipResponse#email #email} => String
|
1179
|
+
# * {Types::GetPartnershipResponse#phone #phone} => String
|
1180
|
+
# * {Types::GetPartnershipResponse#capabilities #capabilities} => Array<String>
|
1181
|
+
# * {Types::GetPartnershipResponse#trading_partner_id #trading_partner_id} => String
|
1182
|
+
# * {Types::GetPartnershipResponse#created_at #created_at} => Time
|
1183
|
+
# * {Types::GetPartnershipResponse#modified_at #modified_at} => Time
|
1184
|
+
#
|
1185
|
+
#
|
1186
|
+
# @example Example: Sample GetPartnership call
|
1187
|
+
#
|
1188
|
+
# resp = client.get_partnership({
|
1189
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
1190
|
+
# })
|
1191
|
+
#
|
1192
|
+
# resp.to_h outputs the following:
|
1193
|
+
# {
|
1194
|
+
# name: "b2bipartner",
|
1195
|
+
# capabilities: [
|
1196
|
+
# "ca-963a8121e4fc4e348",
|
1197
|
+
# ],
|
1198
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1199
|
+
# email: "john@example.com",
|
1200
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1201
|
+
# partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8",
|
1202
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
1203
|
+
# phone: "5555555555",
|
1204
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1205
|
+
# trading_partner_id: "tp-2a17ca447f6f4a8a8",
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @example Request syntax with placeholder values
|
1209
|
+
#
|
1210
|
+
# resp = client.get_partnership({
|
1211
|
+
# partnership_id: "PartnershipId", # required
|
1212
|
+
# })
|
1213
|
+
#
|
1214
|
+
# @example Response structure
|
1215
|
+
#
|
1216
|
+
# resp.profile_id #=> String
|
1217
|
+
# resp.partnership_id #=> String
|
1218
|
+
# resp.partnership_arn #=> String
|
1219
|
+
# resp.name #=> String
|
1220
|
+
# resp.email #=> String
|
1221
|
+
# resp.phone #=> String
|
1222
|
+
# resp.capabilities #=> Array
|
1223
|
+
# resp.capabilities[0] #=> String
|
1224
|
+
# resp.trading_partner_id #=> String
|
1225
|
+
# resp.created_at #=> Time
|
1226
|
+
# resp.modified_at #=> Time
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetPartnership AWS API Documentation
|
1229
|
+
#
|
1230
|
+
# @overload get_partnership(params = {})
|
1231
|
+
# @param [Hash] params ({})
|
1232
|
+
def get_partnership(params = {}, options = {})
|
1233
|
+
req = build_request(:get_partnership, params)
|
1234
|
+
req.send_request(options)
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# Retrieves the details for the profile specified by the profile ID.
|
1238
|
+
# Profiles contain basic information about you and your business.
|
1239
|
+
#
|
1240
|
+
# @option params [required, String] :profile_id
|
1241
|
+
# Specifies the unique, system-generated identifier for the profile.
|
1242
|
+
#
|
1243
|
+
# @return [Types::GetProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1244
|
+
#
|
1245
|
+
# * {Types::GetProfileResponse#profile_id #profile_id} => String
|
1246
|
+
# * {Types::GetProfileResponse#profile_arn #profile_arn} => String
|
1247
|
+
# * {Types::GetProfileResponse#name #name} => String
|
1248
|
+
# * {Types::GetProfileResponse#email #email} => String
|
1249
|
+
# * {Types::GetProfileResponse#phone #phone} => String
|
1250
|
+
# * {Types::GetProfileResponse#business_name #business_name} => String
|
1251
|
+
# * {Types::GetProfileResponse#logging #logging} => String
|
1252
|
+
# * {Types::GetProfileResponse#log_group_name #log_group_name} => String
|
1253
|
+
# * {Types::GetProfileResponse#created_at #created_at} => Time
|
1254
|
+
# * {Types::GetProfileResponse#modified_at #modified_at} => Time
|
1255
|
+
#
|
1256
|
+
#
|
1257
|
+
# @example Example: Sample GetProfile call
|
1258
|
+
#
|
1259
|
+
# resp = client.get_profile({
|
1260
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1261
|
+
# })
|
1262
|
+
#
|
1263
|
+
# resp.to_h outputs the following:
|
1264
|
+
# {
|
1265
|
+
# name: "Shipping Profile",
|
1266
|
+
# business_name: "John's Trucking",
|
1267
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1268
|
+
# email: "john@example.com",
|
1269
|
+
# log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
|
1270
|
+
# logging: "ENABLED",
|
1271
|
+
# phone: "5555555555",
|
1272
|
+
# profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
1273
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1274
|
+
# }
|
1275
|
+
#
|
1276
|
+
# @example Request syntax with placeholder values
|
1277
|
+
#
|
1278
|
+
# resp = client.get_profile({
|
1279
|
+
# profile_id: "ProfileId", # required
|
1280
|
+
# })
|
1281
|
+
#
|
1282
|
+
# @example Response structure
|
1283
|
+
#
|
1284
|
+
# resp.profile_id #=> String
|
1285
|
+
# resp.profile_arn #=> String
|
1286
|
+
# resp.name #=> String
|
1287
|
+
# resp.email #=> String
|
1288
|
+
# resp.phone #=> String
|
1289
|
+
# resp.business_name #=> String
|
1290
|
+
# resp.logging #=> String, one of "ENABLED", "DISABLED"
|
1291
|
+
# resp.log_group_name #=> String
|
1292
|
+
# resp.created_at #=> Time
|
1293
|
+
# resp.modified_at #=> Time
|
1294
|
+
#
|
1295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetProfile AWS API Documentation
|
1296
|
+
#
|
1297
|
+
# @overload get_profile(params = {})
|
1298
|
+
# @param [Hash] params ({})
|
1299
|
+
def get_profile(params = {}, options = {})
|
1300
|
+
req = build_request(:get_profile, params)
|
1301
|
+
req.send_request(options)
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Retrieves the details for the transformer specified by the transformer
|
1305
|
+
# ID. Transformers describe how to process the incoming EDI (electronic
|
1306
|
+
# data interchange) documents, and extract the necessary information.
|
1307
|
+
#
|
1308
|
+
# @option params [required, String] :transformer_id
|
1309
|
+
# Specifies the system-assigned unique identifier for the transformer.
|
1310
|
+
#
|
1311
|
+
# @return [Types::GetTransformerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
|
+
#
|
1313
|
+
# * {Types::GetTransformerResponse#transformer_id #transformer_id} => String
|
1314
|
+
# * {Types::GetTransformerResponse#transformer_arn #transformer_arn} => String
|
1315
|
+
# * {Types::GetTransformerResponse#name #name} => String
|
1316
|
+
# * {Types::GetTransformerResponse#file_format #file_format} => String
|
1317
|
+
# * {Types::GetTransformerResponse#mapping_template #mapping_template} => String
|
1318
|
+
# * {Types::GetTransformerResponse#status #status} => String
|
1319
|
+
# * {Types::GetTransformerResponse#edi_type #edi_type} => Types::EdiType
|
1320
|
+
# * {Types::GetTransformerResponse#sample_document #sample_document} => String
|
1321
|
+
# * {Types::GetTransformerResponse#created_at #created_at} => Time
|
1322
|
+
# * {Types::GetTransformerResponse#modified_at #modified_at} => Time
|
1323
|
+
#
|
1324
|
+
#
|
1325
|
+
# @example Example: Sample GetTransformer call
|
1326
|
+
#
|
1327
|
+
# resp = client.get_transformer({
|
1328
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1329
|
+
# })
|
1330
|
+
#
|
1331
|
+
# resp.to_h outputs the following:
|
1332
|
+
# {
|
1333
|
+
# name: "transformJSON",
|
1334
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1335
|
+
# edi_type: {
|
1336
|
+
# x12_details: {
|
1337
|
+
# version: "VERSION_4010",
|
1338
|
+
# transaction_set: "X12_110",
|
1339
|
+
# },
|
1340
|
+
# },
|
1341
|
+
# file_format: "JSON",
|
1342
|
+
# mapping_template: "$",
|
1343
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1344
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
1345
|
+
# status: "inactive",
|
1346
|
+
# transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
|
1347
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1348
|
+
# }
|
1349
|
+
#
|
1350
|
+
# @example Request syntax with placeholder values
|
1351
|
+
#
|
1352
|
+
# resp = client.get_transformer({
|
1353
|
+
# transformer_id: "TransformerId", # required
|
1354
|
+
# })
|
1355
|
+
#
|
1356
|
+
# @example Response structure
|
1357
|
+
#
|
1358
|
+
# resp.transformer_id #=> String
|
1359
|
+
# resp.transformer_arn #=> String
|
1360
|
+
# resp.name #=> String
|
1361
|
+
# resp.file_format #=> String, one of "XML", "JSON"
|
1362
|
+
# resp.mapping_template #=> String
|
1363
|
+
# resp.status #=> String, one of "active", "inactive"
|
1364
|
+
# resp.edi_type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
1365
|
+
# resp.edi_type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
1366
|
+
# resp.sample_document #=> String
|
1367
|
+
# resp.created_at #=> Time
|
1368
|
+
# resp.modified_at #=> Time
|
1369
|
+
#
|
1370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformer AWS API Documentation
|
1371
|
+
#
|
1372
|
+
# @overload get_transformer(params = {})
|
1373
|
+
# @param [Hash] params ({})
|
1374
|
+
def get_transformer(params = {}, options = {})
|
1375
|
+
req = build_request(:get_transformer, params)
|
1376
|
+
req.send_request(options)
|
1377
|
+
end
|
1378
|
+
|
1379
|
+
# Returns the details of the transformer run, based on the Transformer
|
1380
|
+
# job ID.
|
1381
|
+
#
|
1382
|
+
# @option params [required, String] :transformer_job_id
|
1383
|
+
# Specifies the unique, system-generated identifier for a transformer
|
1384
|
+
# run.
|
1385
|
+
#
|
1386
|
+
# @option params [required, String] :transformer_id
|
1387
|
+
# Specifies the system-assigned unique identifier for the transformer.
|
1388
|
+
#
|
1389
|
+
# @return [Types::GetTransformerJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
|
+
#
|
1391
|
+
# * {Types::GetTransformerJobResponse#status #status} => String
|
1392
|
+
# * {Types::GetTransformerJobResponse#output_files #output_files} => Array<Types::S3Location>
|
1393
|
+
# * {Types::GetTransformerJobResponse#message #message} => String
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
# @example Example: Sample GetTransformerJob call
|
1397
|
+
#
|
1398
|
+
# resp = client.get_transformer_job({
|
1399
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1400
|
+
# transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw",
|
1401
|
+
# })
|
1402
|
+
#
|
1403
|
+
# resp.to_h outputs the following:
|
1404
|
+
# {
|
1405
|
+
# message: "Transformed, writing output",
|
1406
|
+
# output_files: [
|
1407
|
+
# {
|
1408
|
+
# key: "output/sample-214.edi.2023-11-01T10:44:03.353Z.json",
|
1409
|
+
# bucket_name: "gt-edi-test",
|
1410
|
+
# },
|
1411
|
+
# ],
|
1412
|
+
# status: "succeeded",
|
1413
|
+
# }
|
1414
|
+
#
|
1415
|
+
# @example Request syntax with placeholder values
|
1416
|
+
#
|
1417
|
+
# resp = client.get_transformer_job({
|
1418
|
+
# transformer_job_id: "TransformerJobId", # required
|
1419
|
+
# transformer_id: "TransformerId", # required
|
1420
|
+
# })
|
1421
|
+
#
|
1422
|
+
# @example Response structure
|
1423
|
+
#
|
1424
|
+
# resp.status #=> String, one of "running", "succeeded", "failed"
|
1425
|
+
# resp.output_files #=> Array
|
1426
|
+
# resp.output_files[0].bucket_name #=> String
|
1427
|
+
# resp.output_files[0].key #=> String
|
1428
|
+
# resp.message #=> String
|
1429
|
+
#
|
1430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerJob AWS API Documentation
|
1431
|
+
#
|
1432
|
+
# @overload get_transformer_job(params = {})
|
1433
|
+
# @param [Hash] params ({})
|
1434
|
+
def get_transformer_job(params = {}, options = {})
|
1435
|
+
req = build_request(:get_transformer_job, params)
|
1436
|
+
req.send_request(options)
|
1437
|
+
end
|
1438
|
+
|
1439
|
+
# Lists the capabilities associated with your Amazon Web Services
|
1440
|
+
# account for your current or specified region. Capabilities contain the
|
1441
|
+
# information necessary to process incoming EDI (electronic data
|
1442
|
+
# interchange) documents.
|
1443
|
+
#
|
1444
|
+
# @option params [String] :next_token
|
1445
|
+
# When additional results are obtained from the command, a `NextToken`
|
1446
|
+
# parameter is returned in the output. You can then pass the `NextToken`
|
1447
|
+
# parameter in a subsequent command to continue listing additional
|
1448
|
+
# resources.
|
1449
|
+
#
|
1450
|
+
# @option params [Integer] :max_results
|
1451
|
+
# Specifies the maximum number of capabilities to return.
|
1452
|
+
#
|
1453
|
+
# @return [Types::ListCapabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1454
|
+
#
|
1455
|
+
# * {Types::ListCapabilitiesResponse#capabilities #capabilities} => Array<Types::CapabilitySummary>
|
1456
|
+
# * {Types::ListCapabilitiesResponse#next_token #next_token} => String
|
1457
|
+
#
|
1458
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1459
|
+
#
|
1460
|
+
#
|
1461
|
+
# @example Example: Sample ListCapabilities call
|
1462
|
+
#
|
1463
|
+
# resp = client.list_capabilities({
|
1464
|
+
# max_results: 50,
|
1465
|
+
# next_token: "foo",
|
1466
|
+
# })
|
1467
|
+
#
|
1468
|
+
# resp.to_h outputs the following:
|
1469
|
+
# {
|
1470
|
+
# capabilities: [
|
1471
|
+
# {
|
1472
|
+
# name: "b2biexample",
|
1473
|
+
# type: "edi",
|
1474
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
1475
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1476
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1477
|
+
# },
|
1478
|
+
# ],
|
1479
|
+
# next_token: "foo",
|
1480
|
+
# }
|
1481
|
+
#
|
1482
|
+
# @example Request syntax with placeholder values
|
1483
|
+
#
|
1484
|
+
# resp = client.list_capabilities({
|
1485
|
+
# next_token: "PageToken",
|
1486
|
+
# max_results: 1,
|
1487
|
+
# })
|
1488
|
+
#
|
1489
|
+
# @example Response structure
|
1490
|
+
#
|
1491
|
+
# resp.capabilities #=> Array
|
1492
|
+
# resp.capabilities[0].capability_id #=> String
|
1493
|
+
# resp.capabilities[0].name #=> String
|
1494
|
+
# resp.capabilities[0].type #=> String, one of "edi"
|
1495
|
+
# resp.capabilities[0].created_at #=> Time
|
1496
|
+
# resp.capabilities[0].modified_at #=> Time
|
1497
|
+
# resp.next_token #=> String
|
1498
|
+
#
|
1499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListCapabilities AWS API Documentation
|
1500
|
+
#
|
1501
|
+
# @overload list_capabilities(params = {})
|
1502
|
+
# @param [Hash] params ({})
|
1503
|
+
def list_capabilities(params = {}, options = {})
|
1504
|
+
req = build_request(:list_capabilities, params)
|
1505
|
+
req.send_request(options)
|
1506
|
+
end
|
1507
|
+
|
1508
|
+
# Lists the partnerships associated with your Amazon Web Services
|
1509
|
+
# account for your current or specified region. Partnerships link
|
1510
|
+
# trading partners with your profile and a specific transformer, so that
|
1511
|
+
# the EDI (electronic data interchange) documents that they upload to
|
1512
|
+
# Amazon S3 can be processed according to their specifications.
|
1513
|
+
#
|
1514
|
+
# @option params [String] :profile_id
|
1515
|
+
# Specifies the unique, system-generated identifier for the profile
|
1516
|
+
# connected to this partnership.
|
1517
|
+
#
|
1518
|
+
# @option params [String] :next_token
|
1519
|
+
# When additional results are obtained from the command, a `NextToken`
|
1520
|
+
# parameter is returned in the output. You can then pass the `NextToken`
|
1521
|
+
# parameter in a subsequent command to continue listing additional
|
1522
|
+
# resources.
|
1523
|
+
#
|
1524
|
+
# @option params [Integer] :max_results
|
1525
|
+
# Specifies the maximum number of capabilities to return.
|
1526
|
+
#
|
1527
|
+
# @return [Types::ListPartnershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1528
|
+
#
|
1529
|
+
# * {Types::ListPartnershipsResponse#partnerships #partnerships} => Array<Types::PartnershipSummary>
|
1530
|
+
# * {Types::ListPartnershipsResponse#next_token #next_token} => String
|
1531
|
+
#
|
1532
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1533
|
+
#
|
1534
|
+
#
|
1535
|
+
# @example Example: Sample ListPartnerships call
|
1536
|
+
#
|
1537
|
+
# resp = client.list_partnerships({
|
1538
|
+
# max_results: 50,
|
1539
|
+
# next_token: "foo",
|
1540
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1541
|
+
# })
|
1542
|
+
#
|
1543
|
+
# resp.to_h outputs the following:
|
1544
|
+
# {
|
1545
|
+
# next_token: "string",
|
1546
|
+
# partnerships: [
|
1547
|
+
# {
|
1548
|
+
# name: "b2bipartner",
|
1549
|
+
# capabilities: [
|
1550
|
+
# "ca-963a8121e4fc4e348",
|
1551
|
+
# ],
|
1552
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1553
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1554
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
1555
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1556
|
+
# trading_partner_id: "tp-2a17ca447f6f4a8a8",
|
1557
|
+
# },
|
1558
|
+
# ],
|
1559
|
+
# }
|
1560
|
+
#
|
1561
|
+
# @example Request syntax with placeholder values
|
1562
|
+
#
|
1563
|
+
# resp = client.list_partnerships({
|
1564
|
+
# profile_id: "ProfileId",
|
1565
|
+
# next_token: "PageToken",
|
1566
|
+
# max_results: 1,
|
1567
|
+
# })
|
1568
|
+
#
|
1569
|
+
# @example Response structure
|
1570
|
+
#
|
1571
|
+
# resp.partnerships #=> Array
|
1572
|
+
# resp.partnerships[0].profile_id #=> String
|
1573
|
+
# resp.partnerships[0].partnership_id #=> String
|
1574
|
+
# resp.partnerships[0].name #=> String
|
1575
|
+
# resp.partnerships[0].capabilities #=> Array
|
1576
|
+
# resp.partnerships[0].capabilities[0] #=> String
|
1577
|
+
# resp.partnerships[0].trading_partner_id #=> String
|
1578
|
+
# resp.partnerships[0].created_at #=> Time
|
1579
|
+
# resp.partnerships[0].modified_at #=> Time
|
1580
|
+
# resp.next_token #=> String
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListPartnerships AWS API Documentation
|
1583
|
+
#
|
1584
|
+
# @overload list_partnerships(params = {})
|
1585
|
+
# @param [Hash] params ({})
|
1586
|
+
def list_partnerships(params = {}, options = {})
|
1587
|
+
req = build_request(:list_partnerships, params)
|
1588
|
+
req.send_request(options)
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# Lists the profiles associated with your Amazon Web Services account
|
1592
|
+
# for your current or specified region. Profiles contain basic
|
1593
|
+
# information about you and your business.
|
1594
|
+
#
|
1595
|
+
# @option params [String] :next_token
|
1596
|
+
# When additional results are obtained from the command, a `NextToken`
|
1597
|
+
# parameter is returned in the output. You can then pass the `NextToken`
|
1598
|
+
# parameter in a subsequent command to continue listing additional
|
1599
|
+
# resources.
|
1600
|
+
#
|
1601
|
+
# @option params [Integer] :max_results
|
1602
|
+
# Specifies the maximum number of profiles to return.
|
1603
|
+
#
|
1604
|
+
# @return [Types::ListProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1605
|
+
#
|
1606
|
+
# * {Types::ListProfilesResponse#profiles #profiles} => Array<Types::ProfileSummary>
|
1607
|
+
# * {Types::ListProfilesResponse#next_token #next_token} => String
|
1608
|
+
#
|
1609
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1610
|
+
#
|
1611
|
+
#
|
1612
|
+
# @example Example: Sample ListProfiles call
|
1613
|
+
#
|
1614
|
+
# resp = client.list_profiles({
|
1615
|
+
# max_results: 50,
|
1616
|
+
# next_token: "foo",
|
1617
|
+
# })
|
1618
|
+
#
|
1619
|
+
# resp.to_h outputs the following:
|
1620
|
+
# {
|
1621
|
+
# next_token: "foo",
|
1622
|
+
# profiles: [
|
1623
|
+
# {
|
1624
|
+
# name: "Shipping Profile",
|
1625
|
+
# business_name: "John's Trucking",
|
1626
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1627
|
+
# log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
|
1628
|
+
# logging: "ENABLED",
|
1629
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
1630
|
+
# },
|
1631
|
+
# ],
|
1632
|
+
# }
|
1633
|
+
#
|
1634
|
+
# @example Request syntax with placeholder values
|
1635
|
+
#
|
1636
|
+
# resp = client.list_profiles({
|
1637
|
+
# next_token: "PageToken",
|
1638
|
+
# max_results: 1,
|
1639
|
+
# })
|
1640
|
+
#
|
1641
|
+
# @example Response structure
|
1642
|
+
#
|
1643
|
+
# resp.profiles #=> Array
|
1644
|
+
# resp.profiles[0].profile_id #=> String
|
1645
|
+
# resp.profiles[0].name #=> String
|
1646
|
+
# resp.profiles[0].business_name #=> String
|
1647
|
+
# resp.profiles[0].logging #=> String, one of "ENABLED", "DISABLED"
|
1648
|
+
# resp.profiles[0].log_group_name #=> String
|
1649
|
+
# resp.profiles[0].created_at #=> Time
|
1650
|
+
# resp.profiles[0].modified_at #=> Time
|
1651
|
+
# resp.next_token #=> String
|
1652
|
+
#
|
1653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListProfiles AWS API Documentation
|
1654
|
+
#
|
1655
|
+
# @overload list_profiles(params = {})
|
1656
|
+
# @param [Hash] params ({})
|
1657
|
+
def list_profiles(params = {}, options = {})
|
1658
|
+
req = build_request(:list_profiles, params)
|
1659
|
+
req.send_request(options)
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# Lists all of the tags associated with the Amazon Resource Name (ARN)
|
1663
|
+
# that you specify. The resource can be a capability, partnership,
|
1664
|
+
# profile, or transformer.
|
1665
|
+
#
|
1666
|
+
# @option params [required, String] :resource_arn
|
1667
|
+
# Requests the tags associated with a particular Amazon Resource Name
|
1668
|
+
# (ARN). An ARN is an identifier for a specific Amazon Web Services
|
1669
|
+
# resource, such as a capability, partnership, profile, or transformer.
|
1670
|
+
#
|
1671
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1672
|
+
#
|
1673
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1674
|
+
#
|
1675
|
+
#
|
1676
|
+
# @example Example: Sample ListTagsForResources call
|
1677
|
+
#
|
1678
|
+
# resp = client.list_tags_for_resource({
|
1679
|
+
# resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
1680
|
+
# })
|
1681
|
+
#
|
1682
|
+
# resp.to_h outputs the following:
|
1683
|
+
# {
|
1684
|
+
# tags: [
|
1685
|
+
# {
|
1686
|
+
# key: "sampleKey",
|
1687
|
+
# value: "SampleValue",
|
1688
|
+
# },
|
1689
|
+
# ],
|
1690
|
+
# }
|
1691
|
+
#
|
1692
|
+
# @example Request syntax with placeholder values
|
1693
|
+
#
|
1694
|
+
# resp = client.list_tags_for_resource({
|
1695
|
+
# resource_arn: "AmazonResourceName", # required
|
1696
|
+
# })
|
1697
|
+
#
|
1698
|
+
# @example Response structure
|
1699
|
+
#
|
1700
|
+
# resp.tags #=> Array
|
1701
|
+
# resp.tags[0].key #=> String
|
1702
|
+
# resp.tags[0].value #=> String
|
1703
|
+
#
|
1704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTagsForResource AWS API Documentation
|
1705
|
+
#
|
1706
|
+
# @overload list_tags_for_resource(params = {})
|
1707
|
+
# @param [Hash] params ({})
|
1708
|
+
def list_tags_for_resource(params = {}, options = {})
|
1709
|
+
req = build_request(:list_tags_for_resource, params)
|
1710
|
+
req.send_request(options)
|
1711
|
+
end
|
1712
|
+
|
1713
|
+
# Lists the available transformers. Transformers describe how to process
|
1714
|
+
# the incoming EDI (electronic data interchange) documents, and extract
|
1715
|
+
# the necessary information.
|
1716
|
+
#
|
1717
|
+
# @option params [String] :next_token
|
1718
|
+
# When additional results are obtained from the command, a `NextToken`
|
1719
|
+
# parameter is returned in the output. You can then pass the `NextToken`
|
1720
|
+
# parameter in a subsequent command to continue listing additional
|
1721
|
+
# resources.
|
1722
|
+
#
|
1723
|
+
# @option params [Integer] :max_results
|
1724
|
+
# Specifies the number of items to return for the API response.
|
1725
|
+
#
|
1726
|
+
# @return [Types::ListTransformersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1727
|
+
#
|
1728
|
+
# * {Types::ListTransformersResponse#transformers #transformers} => Array<Types::TransformerSummary>
|
1729
|
+
# * {Types::ListTransformersResponse#next_token #next_token} => String
|
1730
|
+
#
|
1731
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1732
|
+
#
|
1733
|
+
#
|
1734
|
+
# @example Example: Sample ListTransformers call
|
1735
|
+
#
|
1736
|
+
# resp = client.list_transformers({
|
1737
|
+
# max_results: 50,
|
1738
|
+
# next_token: "foo",
|
1739
|
+
# })
|
1740
|
+
#
|
1741
|
+
# resp.to_h outputs the following:
|
1742
|
+
# {
|
1743
|
+
# next_token: "foo",
|
1744
|
+
# transformers: [
|
1745
|
+
# {
|
1746
|
+
# name: "transformJSON",
|
1747
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1748
|
+
# edi_type: {
|
1749
|
+
# x12_details: {
|
1750
|
+
# version: "VERSION_4010",
|
1751
|
+
# transaction_set: "X12_110",
|
1752
|
+
# },
|
1753
|
+
# },
|
1754
|
+
# file_format: "JSON",
|
1755
|
+
# mapping_template: "$",
|
1756
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
1757
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
1758
|
+
# status: "inactive",
|
1759
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1760
|
+
# },
|
1761
|
+
# ],
|
1762
|
+
# }
|
1763
|
+
#
|
1764
|
+
# @example Request syntax with placeholder values
|
1765
|
+
#
|
1766
|
+
# resp = client.list_transformers({
|
1767
|
+
# next_token: "PageToken",
|
1768
|
+
# max_results: 1,
|
1769
|
+
# })
|
1770
|
+
#
|
1771
|
+
# @example Response structure
|
1772
|
+
#
|
1773
|
+
# resp.transformers #=> Array
|
1774
|
+
# resp.transformers[0].transformer_id #=> String
|
1775
|
+
# resp.transformers[0].name #=> String
|
1776
|
+
# resp.transformers[0].file_format #=> String, one of "XML", "JSON"
|
1777
|
+
# resp.transformers[0].mapping_template #=> String
|
1778
|
+
# resp.transformers[0].status #=> String, one of "active", "inactive"
|
1779
|
+
# resp.transformers[0].edi_type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
1780
|
+
# resp.transformers[0].edi_type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
1781
|
+
# resp.transformers[0].sample_document #=> String
|
1782
|
+
# resp.transformers[0].created_at #=> Time
|
1783
|
+
# resp.transformers[0].modified_at #=> Time
|
1784
|
+
# resp.next_token #=> String
|
1785
|
+
#
|
1786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTransformers AWS API Documentation
|
1787
|
+
#
|
1788
|
+
# @overload list_transformers(params = {})
|
1789
|
+
# @param [Hash] params ({})
|
1790
|
+
def list_transformers(params = {}, options = {})
|
1791
|
+
req = build_request(:list_transformers, params)
|
1792
|
+
req.send_request(options)
|
1793
|
+
end
|
1794
|
+
|
1795
|
+
# Runs a job, using a transformer, to parse input EDI (electronic data
|
1796
|
+
# interchange) file into the output structures used by Amazon Web
|
1797
|
+
# Services B2BI Data Interchange.
|
1798
|
+
#
|
1799
|
+
# @option params [required, Types::S3Location] :input_file
|
1800
|
+
# Specifies the location of the input file for the transformation. The
|
1801
|
+
# location consists of an Amazon S3 bucket and prefix.
|
1802
|
+
#
|
1803
|
+
# @option params [required, Types::S3Location] :output_location
|
1804
|
+
# Specifies the location of the output file for the transformation. The
|
1805
|
+
# location consists of an Amazon S3 bucket and prefix.
|
1806
|
+
#
|
1807
|
+
# @option params [required, String] :transformer_id
|
1808
|
+
# Specifies the system-assigned unique identifier for the transformer.
|
1809
|
+
#
|
1810
|
+
# @option params [String] :client_token
|
1811
|
+
# Reserved for future use.
|
1812
|
+
#
|
1813
|
+
# **A suitable default value is auto-generated.** You should normally
|
1814
|
+
# not need to pass this option.**
|
1815
|
+
#
|
1816
|
+
# @return [Types::StartTransformerJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1817
|
+
#
|
1818
|
+
# * {Types::StartTransformerJobResponse#transformer_job_id #transformer_job_id} => String
|
1819
|
+
#
|
1820
|
+
#
|
1821
|
+
# @example Example: Sample StartTransformerJob call
|
1822
|
+
#
|
1823
|
+
# resp = client.start_transformer_job({
|
1824
|
+
# client_token: "foo",
|
1825
|
+
# input_file: {
|
1826
|
+
# key: "input/inputFile.txt",
|
1827
|
+
# bucket_name: "test-bucket",
|
1828
|
+
# },
|
1829
|
+
# output_location: {
|
1830
|
+
# key: "output/",
|
1831
|
+
# bucket_name: "test-bucket",
|
1832
|
+
# },
|
1833
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
1834
|
+
# })
|
1835
|
+
#
|
1836
|
+
# resp.to_h outputs the following:
|
1837
|
+
# {
|
1838
|
+
# transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw",
|
1839
|
+
# }
|
1840
|
+
#
|
1841
|
+
# @example Request syntax with placeholder values
|
1842
|
+
#
|
1843
|
+
# resp = client.start_transformer_job({
|
1844
|
+
# input_file: { # required
|
1845
|
+
# bucket_name: "BucketName",
|
1846
|
+
# key: "S3Key",
|
1847
|
+
# },
|
1848
|
+
# output_location: { # required
|
1849
|
+
# bucket_name: "BucketName",
|
1850
|
+
# key: "S3Key",
|
1851
|
+
# },
|
1852
|
+
# transformer_id: "TransformerId", # required
|
1853
|
+
# client_token: "String",
|
1854
|
+
# })
|
1855
|
+
#
|
1856
|
+
# @example Response structure
|
1857
|
+
#
|
1858
|
+
# resp.transformer_job_id #=> String
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/StartTransformerJob AWS API Documentation
|
1861
|
+
#
|
1862
|
+
# @overload start_transformer_job(params = {})
|
1863
|
+
# @param [Hash] params ({})
|
1864
|
+
def start_transformer_job(params = {}, options = {})
|
1865
|
+
req = build_request(:start_transformer_job, params)
|
1866
|
+
req.send_request(options)
|
1867
|
+
end
|
1868
|
+
|
1869
|
+
# Attaches a key-value pair to a resource, as identified by its Amazon
|
1870
|
+
# Resource Name (ARN). Resources are capability, partnership, profile,
|
1871
|
+
# transformers and other entities.
|
1872
|
+
#
|
1873
|
+
# There is no response returned from this call.
|
1874
|
+
#
|
1875
|
+
# @option params [required, String] :resource_arn
|
1876
|
+
# Specifies an Amazon Resource Name (ARN) for a specific Amazon Web
|
1877
|
+
# Services resource, such as a capability, partnership, profile, or
|
1878
|
+
# transformer.
|
1879
|
+
#
|
1880
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1881
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
1882
|
+
# group and search for resources by type. You can attach this metadata
|
1883
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
1884
|
+
#
|
1885
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1886
|
+
#
|
1887
|
+
#
|
1888
|
+
# @example Example: Sample TagResource call
|
1889
|
+
#
|
1890
|
+
# resp = client.tag_resource({
|
1891
|
+
# resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
1892
|
+
# tags: [
|
1893
|
+
# {
|
1894
|
+
# key: "sampleKey",
|
1895
|
+
# value: "SampleValue",
|
1896
|
+
# },
|
1897
|
+
# ],
|
1898
|
+
# })
|
1899
|
+
#
|
1900
|
+
# @example Request syntax with placeholder values
|
1901
|
+
#
|
1902
|
+
# resp = client.tag_resource({
|
1903
|
+
# resource_arn: "AmazonResourceName", # required
|
1904
|
+
# tags: [ # required
|
1905
|
+
# {
|
1906
|
+
# key: "TagKey", # required
|
1907
|
+
# value: "TagValue", # required
|
1908
|
+
# },
|
1909
|
+
# ],
|
1910
|
+
# })
|
1911
|
+
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TagResource AWS API Documentation
|
1913
|
+
#
|
1914
|
+
# @overload tag_resource(params = {})
|
1915
|
+
# @param [Hash] params ({})
|
1916
|
+
def tag_resource(params = {}, options = {})
|
1917
|
+
req = build_request(:tag_resource, params)
|
1918
|
+
req.send_request(options)
|
1919
|
+
end
|
1920
|
+
|
1921
|
+
# Maps the input file according to the provided template file.
|
1922
|
+
#
|
1923
|
+
# @option params [required, String] :input_file_content
|
1924
|
+
# Specify the EDI (electronic data interchange) file that is used as
|
1925
|
+
# input for the transform.
|
1926
|
+
#
|
1927
|
+
# @option params [required, String] :mapping_template
|
1928
|
+
# Specifies the name of the mapping template for the transformer. This
|
1929
|
+
# template is used to convert the input document into the correct set of
|
1930
|
+
# objects.
|
1931
|
+
#
|
1932
|
+
# @option params [required, String] :file_format
|
1933
|
+
# Specifies that the currently supported file formats for EDI
|
1934
|
+
# transformations are `JSON` and `XML`.
|
1935
|
+
#
|
1936
|
+
# @return [Types::TestMappingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1937
|
+
#
|
1938
|
+
# * {Types::TestMappingResponse#mapped_file_content #mapped_file_content} => String
|
1939
|
+
#
|
1940
|
+
#
|
1941
|
+
# @example Example: Sample TestMapping call
|
1942
|
+
#
|
1943
|
+
# resp = client.test_mapping({
|
1944
|
+
# file_format: "JSON",
|
1945
|
+
# input_file_content: "Sample file content",
|
1946
|
+
# mapping_template: "$",
|
1947
|
+
# })
|
1948
|
+
#
|
1949
|
+
# resp.to_h outputs the following:
|
1950
|
+
# {
|
1951
|
+
# mapped_file_content: "Sample file content",
|
1952
|
+
# }
|
1953
|
+
#
|
1954
|
+
# @example Request syntax with placeholder values
|
1955
|
+
#
|
1956
|
+
# resp = client.test_mapping({
|
1957
|
+
# input_file_content: "TestMappingInputFileContent", # required
|
1958
|
+
# mapping_template: "MappingTemplate", # required
|
1959
|
+
# file_format: "XML", # required, accepts XML, JSON
|
1960
|
+
# })
|
1961
|
+
#
|
1962
|
+
# @example Response structure
|
1963
|
+
#
|
1964
|
+
# resp.mapped_file_content #=> String
|
1965
|
+
#
|
1966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestMapping AWS API Documentation
|
1967
|
+
#
|
1968
|
+
# @overload test_mapping(params = {})
|
1969
|
+
# @param [Hash] params ({})
|
1970
|
+
def test_mapping(params = {}, options = {})
|
1971
|
+
req = build_request(:test_mapping, params)
|
1972
|
+
req.send_request(options)
|
1973
|
+
end
|
1974
|
+
|
1975
|
+
# Parses the input EDI (electronic data interchange) file.
|
1976
|
+
#
|
1977
|
+
# @option params [required, Types::S3Location] :input_file
|
1978
|
+
# Specifies an `S3Location` object, which contains the Amazon S3 bucket
|
1979
|
+
# and prefix for the location of the input file.
|
1980
|
+
#
|
1981
|
+
# @option params [required, String] :file_format
|
1982
|
+
# Specifies that the currently supported file formats for EDI
|
1983
|
+
# transformations are `JSON` and `XML`.
|
1984
|
+
#
|
1985
|
+
# @option params [required, Types::EdiType] :edi_type
|
1986
|
+
# Specifies the details for the EDI standard that is being used for the
|
1987
|
+
# transformer. Currently, only X12 is supported. X12 is a set of
|
1988
|
+
# standards and corresponding messages that define specific business
|
1989
|
+
# documents.
|
1990
|
+
#
|
1991
|
+
# @return [Types::TestParsingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1992
|
+
#
|
1993
|
+
# * {Types::TestParsingResponse#parsed_file_content #parsed_file_content} => String
|
1994
|
+
#
|
1995
|
+
#
|
1996
|
+
# @example Example: Sample TestParsing call
|
1997
|
+
#
|
1998
|
+
# resp = client.test_parsing({
|
1999
|
+
# edi_type: {
|
2000
|
+
# x12_details: {
|
2001
|
+
# version: "VERSION_4010",
|
2002
|
+
# transaction_set: "X12_110",
|
2003
|
+
# },
|
2004
|
+
# },
|
2005
|
+
# file_format: "JSON",
|
2006
|
+
# input_file: {
|
2007
|
+
# key: "sampleFile.txt",
|
2008
|
+
# bucket_name: "test-bucket",
|
2009
|
+
# },
|
2010
|
+
# })
|
2011
|
+
#
|
2012
|
+
# resp.to_h outputs the following:
|
2013
|
+
# {
|
2014
|
+
# parsed_file_content: "Sample parsed file content",
|
2015
|
+
# }
|
2016
|
+
#
|
2017
|
+
# @example Request syntax with placeholder values
|
2018
|
+
#
|
2019
|
+
# resp = client.test_parsing({
|
2020
|
+
# input_file: { # required
|
2021
|
+
# bucket_name: "BucketName",
|
2022
|
+
# key: "S3Key",
|
2023
|
+
# },
|
2024
|
+
# file_format: "XML", # required, accepts XML, JSON
|
2025
|
+
# edi_type: { # required
|
2026
|
+
# x12_details: {
|
2027
|
+
# transaction_set: "X12_110", # accepts X12_110, X12_180, X12_204, X12_210, X12_214, X12_215, X12_310, X12_315, X12_322, X12_404, X12_410, X12_820, X12_824, X12_830, X12_846, X12_850, X12_852, X12_855, X12_856, X12_860, X12_861, X12_864, X12_940, X12_990, X12_997
|
2028
|
+
# version: "VERSION_4010", # accepts VERSION_4010, VERSION_4030, VERSION_5010
|
2029
|
+
# },
|
2030
|
+
# },
|
2031
|
+
# })
|
2032
|
+
#
|
2033
|
+
# @example Response structure
|
2034
|
+
#
|
2035
|
+
# resp.parsed_file_content #=> String
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestParsing AWS API Documentation
|
2038
|
+
#
|
2039
|
+
# @overload test_parsing(params = {})
|
2040
|
+
# @param [Hash] params ({})
|
2041
|
+
def test_parsing(params = {}, options = {})
|
2042
|
+
req = build_request(:test_parsing, params)
|
2043
|
+
req.send_request(options)
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# Detaches a key-value pair from the specified resource, as identified
|
2047
|
+
# by its Amazon Resource Name (ARN). Resources are capability,
|
2048
|
+
# partnership, profile, transformers and other entities.
|
2049
|
+
#
|
2050
|
+
# @option params [required, String] :resource_arn
|
2051
|
+
# Specifies an Amazon Resource Name (ARN) for a specific Amazon Web
|
2052
|
+
# Services resource, such as a capability, partnership, profile, or
|
2053
|
+
# transformer.
|
2054
|
+
#
|
2055
|
+
# @option params [required, Array<String>] :tag_keys
|
2056
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
2057
|
+
# group and search for resources by type. You can attach this metadata
|
2058
|
+
# to resources (capabilities, partnerships, and so on) for any purpose.
|
2059
|
+
#
|
2060
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2061
|
+
#
|
2062
|
+
#
|
2063
|
+
# @example Example: Sample UntagResource call
|
2064
|
+
#
|
2065
|
+
# resp = client.untag_resource({
|
2066
|
+
# resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
2067
|
+
# tag_keys: [
|
2068
|
+
# "sampleKey",
|
2069
|
+
# ],
|
2070
|
+
# })
|
2071
|
+
#
|
2072
|
+
# @example Request syntax with placeholder values
|
2073
|
+
#
|
2074
|
+
# resp = client.untag_resource({
|
2075
|
+
# resource_arn: "AmazonResourceName", # required
|
2076
|
+
# tag_keys: ["TagKey"], # required
|
2077
|
+
# })
|
2078
|
+
#
|
2079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UntagResource AWS API Documentation
|
2080
|
+
#
|
2081
|
+
# @overload untag_resource(params = {})
|
2082
|
+
# @param [Hash] params ({})
|
2083
|
+
def untag_resource(params = {}, options = {})
|
2084
|
+
req = build_request(:untag_resource, params)
|
2085
|
+
req.send_request(options)
|
2086
|
+
end
|
2087
|
+
|
2088
|
+
# Updates some of the parameters for a capability, based on the
|
2089
|
+
# specified parameters. Capabilities contain the information necessary
|
2090
|
+
# to process incoming EDI (electronic data interchange) documents.
|
2091
|
+
#
|
2092
|
+
# @option params [required, String] :capability_id
|
2093
|
+
# Specifies a system-assigned unique identifier for the capability.
|
2094
|
+
#
|
2095
|
+
# @option params [String] :name
|
2096
|
+
# Specifies a new name for the capability, to replace the existing name.
|
2097
|
+
#
|
2098
|
+
# @option params [Types::CapabilityConfiguration] :configuration
|
2099
|
+
# Specifies a structure that contains the details for a capability.
|
2100
|
+
#
|
2101
|
+
# @option params [Array<Types::S3Location>] :instructions_documents
|
2102
|
+
# Specifies one or more locations in Amazon S3, each specifying an EDI
|
2103
|
+
# document that can be used with this capability. Each item contains the
|
2104
|
+
# name of the bucket and the key, to identify the document's location.
|
2105
|
+
#
|
2106
|
+
# @return [Types::UpdateCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2107
|
+
#
|
2108
|
+
# * {Types::UpdateCapabilityResponse#capability_id #capability_id} => String
|
2109
|
+
# * {Types::UpdateCapabilityResponse#capability_arn #capability_arn} => String
|
2110
|
+
# * {Types::UpdateCapabilityResponse#name #name} => String
|
2111
|
+
# * {Types::UpdateCapabilityResponse#type #type} => String
|
2112
|
+
# * {Types::UpdateCapabilityResponse#configuration #configuration} => Types::CapabilityConfiguration
|
2113
|
+
# * {Types::UpdateCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location>
|
2114
|
+
# * {Types::UpdateCapabilityResponse#created_at #created_at} => Time
|
2115
|
+
# * {Types::UpdateCapabilityResponse#modified_at #modified_at} => Time
|
2116
|
+
#
|
2117
|
+
#
|
2118
|
+
# @example Example: Sample UpdateCapability call
|
2119
|
+
#
|
2120
|
+
# resp = client.update_capability({
|
2121
|
+
# name: "b2biexample",
|
2122
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
2123
|
+
# configuration: {
|
2124
|
+
# edi: {
|
2125
|
+
# type: {
|
2126
|
+
# x12_details: {
|
2127
|
+
# version: "VERSION_4010",
|
2128
|
+
# transaction_set: "X12_110",
|
2129
|
+
# },
|
2130
|
+
# },
|
2131
|
+
# input_location: {
|
2132
|
+
# key: "input/",
|
2133
|
+
# bucket_name: "test-bucket",
|
2134
|
+
# },
|
2135
|
+
# output_location: {
|
2136
|
+
# key: "output/",
|
2137
|
+
# bucket_name: "test-bucket",
|
2138
|
+
# },
|
2139
|
+
# transformer_id: "tr-9a893cf536df4658b",
|
2140
|
+
# },
|
2141
|
+
# },
|
2142
|
+
# instructions_documents: [
|
2143
|
+
# {
|
2144
|
+
# key: "instructiondoc.txt",
|
2145
|
+
# bucket_name: "test-bucket",
|
2146
|
+
# },
|
2147
|
+
# ],
|
2148
|
+
# })
|
2149
|
+
#
|
2150
|
+
# resp.to_h outputs the following:
|
2151
|
+
# {
|
2152
|
+
# name: "b2biexample",
|
2153
|
+
# type: "edi",
|
2154
|
+
# capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
|
2155
|
+
# capability_id: "ca-963a8121e4fc4e348",
|
2156
|
+
# configuration: {
|
2157
|
+
# edi: {
|
2158
|
+
# type: {
|
2159
|
+
# x12_details: {
|
2160
|
+
# version: "VERSION_4010",
|
2161
|
+
# transaction_set: "X12_110",
|
2162
|
+
# },
|
2163
|
+
# },
|
2164
|
+
# input_location: {
|
2165
|
+
# key: "input/",
|
2166
|
+
# bucket_name: "test-bucket",
|
2167
|
+
# },
|
2168
|
+
# output_location: {
|
2169
|
+
# key: "output/",
|
2170
|
+
# bucket_name: "test-bucket",
|
2171
|
+
# },
|
2172
|
+
# transformer_id: "tr-9a893cf536df4658b",
|
2173
|
+
# },
|
2174
|
+
# },
|
2175
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2176
|
+
# instructions_documents: [
|
2177
|
+
# {
|
2178
|
+
# key: "instructiondoc.txt",
|
2179
|
+
# bucket_name: "test-bucket",
|
2180
|
+
# },
|
2181
|
+
# ],
|
2182
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2183
|
+
# }
|
2184
|
+
#
|
2185
|
+
# @example Request syntax with placeholder values
|
2186
|
+
#
|
2187
|
+
# resp = client.update_capability({
|
2188
|
+
# capability_id: "CapabilityId", # required
|
2189
|
+
# name: "CapabilityName",
|
2190
|
+
# configuration: {
|
2191
|
+
# edi: {
|
2192
|
+
# type: { # required
|
2193
|
+
# x12_details: {
|
2194
|
+
# transaction_set: "X12_110", # accepts X12_110, X12_180, X12_204, X12_210, X12_214, X12_215, X12_310, X12_315, X12_322, X12_404, X12_410, X12_820, X12_824, X12_830, X12_846, X12_850, X12_852, X12_855, X12_856, X12_860, X12_861, X12_864, X12_940, X12_990, X12_997
|
2195
|
+
# version: "VERSION_4010", # accepts VERSION_4010, VERSION_4030, VERSION_5010
|
2196
|
+
# },
|
2197
|
+
# },
|
2198
|
+
# input_location: { # required
|
2199
|
+
# bucket_name: "BucketName",
|
2200
|
+
# key: "S3Key",
|
2201
|
+
# },
|
2202
|
+
# output_location: { # required
|
2203
|
+
# bucket_name: "BucketName",
|
2204
|
+
# key: "S3Key",
|
2205
|
+
# },
|
2206
|
+
# transformer_id: "TransformerId", # required
|
2207
|
+
# },
|
2208
|
+
# },
|
2209
|
+
# instructions_documents: [
|
2210
|
+
# {
|
2211
|
+
# bucket_name: "BucketName",
|
2212
|
+
# key: "S3Key",
|
2213
|
+
# },
|
2214
|
+
# ],
|
2215
|
+
# })
|
2216
|
+
#
|
2217
|
+
# @example Response structure
|
2218
|
+
#
|
2219
|
+
# resp.capability_id #=> String
|
2220
|
+
# resp.capability_arn #=> String
|
2221
|
+
# resp.name #=> String
|
2222
|
+
# resp.type #=> String, one of "edi"
|
2223
|
+
# resp.configuration.edi.type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
2224
|
+
# resp.configuration.edi.type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
2225
|
+
# resp.configuration.edi.input_location.bucket_name #=> String
|
2226
|
+
# resp.configuration.edi.input_location.key #=> String
|
2227
|
+
# resp.configuration.edi.output_location.bucket_name #=> String
|
2228
|
+
# resp.configuration.edi.output_location.key #=> String
|
2229
|
+
# resp.configuration.edi.transformer_id #=> String
|
2230
|
+
# resp.instructions_documents #=> Array
|
2231
|
+
# resp.instructions_documents[0].bucket_name #=> String
|
2232
|
+
# resp.instructions_documents[0].key #=> String
|
2233
|
+
# resp.created_at #=> Time
|
2234
|
+
# resp.modified_at #=> Time
|
2235
|
+
#
|
2236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateCapability AWS API Documentation
|
2237
|
+
#
|
2238
|
+
# @overload update_capability(params = {})
|
2239
|
+
# @param [Hash] params ({})
|
2240
|
+
def update_capability(params = {}, options = {})
|
2241
|
+
req = build_request(:update_capability, params)
|
2242
|
+
req.send_request(options)
|
2243
|
+
end
|
2244
|
+
|
2245
|
+
# Updates some of the parameters for a partnership between a customer
|
2246
|
+
# and trading partner. Partnerships link trading partners with your
|
2247
|
+
# profile and a specific transformer, so that the EDI (electronic data
|
2248
|
+
# interchange) documents that they upload to Amazon S3 can be processed
|
2249
|
+
# according to their specifications.
|
2250
|
+
#
|
2251
|
+
# @option params [required, String] :partnership_id
|
2252
|
+
# Specifies the unique, system-generated identifier for a partnership.
|
2253
|
+
#
|
2254
|
+
# @option params [String] :name
|
2255
|
+
# The name of the partnership, used to identify it.
|
2256
|
+
#
|
2257
|
+
# @option params [Array<String>] :capabilities
|
2258
|
+
# List of the capabilities associated with this partnership.
|
2259
|
+
#
|
2260
|
+
# @return [Types::UpdatePartnershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2261
|
+
#
|
2262
|
+
# * {Types::UpdatePartnershipResponse#profile_id #profile_id} => String
|
2263
|
+
# * {Types::UpdatePartnershipResponse#partnership_id #partnership_id} => String
|
2264
|
+
# * {Types::UpdatePartnershipResponse#partnership_arn #partnership_arn} => String
|
2265
|
+
# * {Types::UpdatePartnershipResponse#name #name} => String
|
2266
|
+
# * {Types::UpdatePartnershipResponse#email #email} => String
|
2267
|
+
# * {Types::UpdatePartnershipResponse#phone #phone} => String
|
2268
|
+
# * {Types::UpdatePartnershipResponse#capabilities #capabilities} => Array<String>
|
2269
|
+
# * {Types::UpdatePartnershipResponse#trading_partner_id #trading_partner_id} => String
|
2270
|
+
# * {Types::UpdatePartnershipResponse#created_at #created_at} => Time
|
2271
|
+
# * {Types::UpdatePartnershipResponse#modified_at #modified_at} => Time
|
2272
|
+
#
|
2273
|
+
#
|
2274
|
+
# @example Example: Sample UpdatePartnership call
|
2275
|
+
#
|
2276
|
+
# resp = client.update_partnership({
|
2277
|
+
# name: "b2bipartner",
|
2278
|
+
# capabilities: [
|
2279
|
+
# "ca-963a8121e4fc4e348",
|
2280
|
+
# ],
|
2281
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
2282
|
+
# })
|
2283
|
+
#
|
2284
|
+
# resp.to_h outputs the following:
|
2285
|
+
# {
|
2286
|
+
# name: "b2bipartner",
|
2287
|
+
# capabilities: [
|
2288
|
+
# "ca-963a8121e4fc4e348",
|
2289
|
+
# ],
|
2290
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2291
|
+
# email: "john@example.com",
|
2292
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2293
|
+
# partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
|
2294
|
+
# partnership_id: "ps-219fa02f5b4242af8",
|
2295
|
+
# phone: "5555555555",
|
2296
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
2297
|
+
# trading_partner_id: "tp-2a17ca447f6f4a8a8",
|
2298
|
+
# }
|
2299
|
+
#
|
2300
|
+
# @example Request syntax with placeholder values
|
2301
|
+
#
|
2302
|
+
# resp = client.update_partnership({
|
2303
|
+
# partnership_id: "PartnershipId", # required
|
2304
|
+
# name: "PartnerName",
|
2305
|
+
# capabilities: ["CapabilityId"],
|
2306
|
+
# })
|
2307
|
+
#
|
2308
|
+
# @example Response structure
|
2309
|
+
#
|
2310
|
+
# resp.profile_id #=> String
|
2311
|
+
# resp.partnership_id #=> String
|
2312
|
+
# resp.partnership_arn #=> String
|
2313
|
+
# resp.name #=> String
|
2314
|
+
# resp.email #=> String
|
2315
|
+
# resp.phone #=> String
|
2316
|
+
# resp.capabilities #=> Array
|
2317
|
+
# resp.capabilities[0] #=> String
|
2318
|
+
# resp.trading_partner_id #=> String
|
2319
|
+
# resp.created_at #=> Time
|
2320
|
+
# resp.modified_at #=> Time
|
2321
|
+
#
|
2322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdatePartnership AWS API Documentation
|
2323
|
+
#
|
2324
|
+
# @overload update_partnership(params = {})
|
2325
|
+
# @param [Hash] params ({})
|
2326
|
+
def update_partnership(params = {}, options = {})
|
2327
|
+
req = build_request(:update_partnership, params)
|
2328
|
+
req.send_request(options)
|
2329
|
+
end
|
2330
|
+
|
2331
|
+
# Updates the specified parameters for a profile. Profiles contain basic
|
2332
|
+
# information about you and your business.
|
2333
|
+
#
|
2334
|
+
# @option params [required, String] :profile_id
|
2335
|
+
# Specifies the unique, system-generated identifier for the profile.
|
2336
|
+
#
|
2337
|
+
# @option params [String] :name
|
2338
|
+
# The name of the profile, used to identify it.
|
2339
|
+
#
|
2340
|
+
# @option params [String] :email
|
2341
|
+
# Specifies the email address associated with this customer profile.
|
2342
|
+
#
|
2343
|
+
# @option params [String] :phone
|
2344
|
+
# Specifies the phone number associated with the profile.
|
2345
|
+
#
|
2346
|
+
# @option params [String] :business_name
|
2347
|
+
# Specifies the name for the business associated with this profile.
|
2348
|
+
#
|
2349
|
+
# @return [Types::UpdateProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2350
|
+
#
|
2351
|
+
# * {Types::UpdateProfileResponse#profile_id #profile_id} => String
|
2352
|
+
# * {Types::UpdateProfileResponse#profile_arn #profile_arn} => String
|
2353
|
+
# * {Types::UpdateProfileResponse#name #name} => String
|
2354
|
+
# * {Types::UpdateProfileResponse#email #email} => String
|
2355
|
+
# * {Types::UpdateProfileResponse#phone #phone} => String
|
2356
|
+
# * {Types::UpdateProfileResponse#business_name #business_name} => String
|
2357
|
+
# * {Types::UpdateProfileResponse#logging #logging} => String
|
2358
|
+
# * {Types::UpdateProfileResponse#log_group_name #log_group_name} => String
|
2359
|
+
# * {Types::UpdateProfileResponse#created_at #created_at} => Time
|
2360
|
+
# * {Types::UpdateProfileResponse#modified_at #modified_at} => Time
|
2361
|
+
#
|
2362
|
+
#
|
2363
|
+
# @example Example: Sample UpdateProfile call
|
2364
|
+
#
|
2365
|
+
# resp = client.update_profile({
|
2366
|
+
# name: "Shipping Profile",
|
2367
|
+
# business_name: "John's Shipping",
|
2368
|
+
# email: "john@example.com",
|
2369
|
+
# phone: "5555555555",
|
2370
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
2371
|
+
# })
|
2372
|
+
#
|
2373
|
+
# resp.to_h outputs the following:
|
2374
|
+
# {
|
2375
|
+
# name: "Shipping Profile",
|
2376
|
+
# business_name: "John's Trucking",
|
2377
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2378
|
+
# email: "john@example.com",
|
2379
|
+
# log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
|
2380
|
+
# logging: "ENABLED",
|
2381
|
+
# modified_at: Time.parse("2023-11-02T21:51:05.504Z"),
|
2382
|
+
# phone: "5555555555",
|
2383
|
+
# profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
|
2384
|
+
# profile_id: "p-60fbc37c87f04fce9",
|
2385
|
+
# }
|
2386
|
+
#
|
2387
|
+
# @example Request syntax with placeholder values
|
2388
|
+
#
|
2389
|
+
# resp = client.update_profile({
|
2390
|
+
# profile_id: "ProfileId", # required
|
2391
|
+
# name: "ProfileName",
|
2392
|
+
# email: "Email",
|
2393
|
+
# phone: "Phone",
|
2394
|
+
# business_name: "BusinessName",
|
2395
|
+
# })
|
2396
|
+
#
|
2397
|
+
# @example Response structure
|
2398
|
+
#
|
2399
|
+
# resp.profile_id #=> String
|
2400
|
+
# resp.profile_arn #=> String
|
2401
|
+
# resp.name #=> String
|
2402
|
+
# resp.email #=> String
|
2403
|
+
# resp.phone #=> String
|
2404
|
+
# resp.business_name #=> String
|
2405
|
+
# resp.logging #=> String, one of "ENABLED", "DISABLED"
|
2406
|
+
# resp.log_group_name #=> String
|
2407
|
+
# resp.created_at #=> Time
|
2408
|
+
# resp.modified_at #=> Time
|
2409
|
+
#
|
2410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateProfile AWS API Documentation
|
2411
|
+
#
|
2412
|
+
# @overload update_profile(params = {})
|
2413
|
+
# @param [Hash] params ({})
|
2414
|
+
def update_profile(params = {}, options = {})
|
2415
|
+
req = build_request(:update_profile, params)
|
2416
|
+
req.send_request(options)
|
2417
|
+
end
|
2418
|
+
|
2419
|
+
# Updates the specified parameters for a transformer. Transformers
|
2420
|
+
# describe how to process the incoming EDI (electronic data interchange)
|
2421
|
+
# documents, and extract the necessary information.
|
2422
|
+
#
|
2423
|
+
# @option params [required, String] :transformer_id
|
2424
|
+
# Specifies the system-assigned unique identifier for the transformer.
|
2425
|
+
#
|
2426
|
+
# @option params [String] :name
|
2427
|
+
# Specify a new name for the transformer, if you want to update it.
|
2428
|
+
#
|
2429
|
+
# @option params [String] :file_format
|
2430
|
+
# Specifies that the currently supported file formats for EDI
|
2431
|
+
# transformations are `JSON` and `XML`.
|
2432
|
+
#
|
2433
|
+
# @option params [String] :mapping_template
|
2434
|
+
# Specifies the name of the mapping template for the transformer. This
|
2435
|
+
# template is used to convert the input document into the correct set of
|
2436
|
+
# objects.
|
2437
|
+
#
|
2438
|
+
# @option params [String] :status
|
2439
|
+
# Specifies the transformer's status. You can update the state of the
|
2440
|
+
# transformer, from `active` to `inactive`, or `inactive` to `active`.
|
2441
|
+
#
|
2442
|
+
# @option params [Types::EdiType] :edi_type
|
2443
|
+
# Specifies the details for the EDI standard that is being used for the
|
2444
|
+
# transformer. Currently, only X12 is supported. X12 is a set of
|
2445
|
+
# standards and corresponding messages that define specific business
|
2446
|
+
# documents.
|
2447
|
+
#
|
2448
|
+
# @option params [String] :sample_document
|
2449
|
+
# Specifies a sample EDI document that is used by a transformer as a
|
2450
|
+
# guide for processing the EDI data.
|
2451
|
+
#
|
2452
|
+
# @return [Types::UpdateTransformerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2453
|
+
#
|
2454
|
+
# * {Types::UpdateTransformerResponse#transformer_id #transformer_id} => String
|
2455
|
+
# * {Types::UpdateTransformerResponse#transformer_arn #transformer_arn} => String
|
2456
|
+
# * {Types::UpdateTransformerResponse#name #name} => String
|
2457
|
+
# * {Types::UpdateTransformerResponse#file_format #file_format} => String
|
2458
|
+
# * {Types::UpdateTransformerResponse#mapping_template #mapping_template} => String
|
2459
|
+
# * {Types::UpdateTransformerResponse#status #status} => String
|
2460
|
+
# * {Types::UpdateTransformerResponse#edi_type #edi_type} => Types::EdiType
|
2461
|
+
# * {Types::UpdateTransformerResponse#sample_document #sample_document} => String
|
2462
|
+
# * {Types::UpdateTransformerResponse#created_at #created_at} => Time
|
2463
|
+
# * {Types::UpdateTransformerResponse#modified_at #modified_at} => Time
|
2464
|
+
#
|
2465
|
+
#
|
2466
|
+
# @example Example: Sample UpdateTransformer call
|
2467
|
+
#
|
2468
|
+
# resp = client.update_transformer({
|
2469
|
+
# name: "transformJSON",
|
2470
|
+
# edi_type: {
|
2471
|
+
# x12_details: {
|
2472
|
+
# version: "VERSION_4010",
|
2473
|
+
# transaction_set: "X12_110",
|
2474
|
+
# },
|
2475
|
+
# },
|
2476
|
+
# file_format: "JSON",
|
2477
|
+
# mapping_template: "{}",
|
2478
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
2479
|
+
# status: "inactive",
|
2480
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
2481
|
+
# })
|
2482
|
+
#
|
2483
|
+
# resp.to_h outputs the following:
|
2484
|
+
# {
|
2485
|
+
# name: "transformJSON",
|
2486
|
+
# created_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2487
|
+
# edi_type: {
|
2488
|
+
# x12_details: {
|
2489
|
+
# version: "VERSION_4010",
|
2490
|
+
# transaction_set: "X12_110",
|
2491
|
+
# },
|
2492
|
+
# },
|
2493
|
+
# file_format: "JSON",
|
2494
|
+
# mapping_template: "$",
|
2495
|
+
# modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
|
2496
|
+
# sample_document: "s3://test-bucket/sampleDoc.txt",
|
2497
|
+
# status: "inactive",
|
2498
|
+
# transformer_arn: "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9",
|
2499
|
+
# transformer_id: "tr-974c129999f84d8c9",
|
2500
|
+
# }
|
2501
|
+
#
|
2502
|
+
# @example Request syntax with placeholder values
|
2503
|
+
#
|
2504
|
+
# resp = client.update_transformer({
|
2505
|
+
# transformer_id: "TransformerId", # required
|
2506
|
+
# name: "TransformerName",
|
2507
|
+
# file_format: "XML", # accepts XML, JSON
|
2508
|
+
# mapping_template: "MappingTemplate",
|
2509
|
+
# status: "active", # accepts active, inactive
|
2510
|
+
# edi_type: {
|
2511
|
+
# x12_details: {
|
2512
|
+
# transaction_set: "X12_110", # accepts X12_110, X12_180, X12_204, X12_210, X12_214, X12_215, X12_310, X12_315, X12_322, X12_404, X12_410, X12_820, X12_824, X12_830, X12_846, X12_850, X12_852, X12_855, X12_856, X12_860, X12_861, X12_864, X12_940, X12_990, X12_997
|
2513
|
+
# version: "VERSION_4010", # accepts VERSION_4010, VERSION_4030, VERSION_5010
|
2514
|
+
# },
|
2515
|
+
# },
|
2516
|
+
# sample_document: "FileLocation",
|
2517
|
+
# })
|
2518
|
+
#
|
2519
|
+
# @example Response structure
|
2520
|
+
#
|
2521
|
+
# resp.transformer_id #=> String
|
2522
|
+
# resp.transformer_arn #=> String
|
2523
|
+
# resp.name #=> String
|
2524
|
+
# resp.file_format #=> String, one of "XML", "JSON"
|
2525
|
+
# resp.mapping_template #=> String
|
2526
|
+
# resp.status #=> String, one of "active", "inactive"
|
2527
|
+
# resp.edi_type.x12_details.transaction_set #=> String, one of "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997"
|
2528
|
+
# resp.edi_type.x12_details.version #=> String, one of "VERSION_4010", "VERSION_4030", "VERSION_5010"
|
2529
|
+
# resp.sample_document #=> String
|
2530
|
+
# resp.created_at #=> Time
|
2531
|
+
# resp.modified_at #=> Time
|
2532
|
+
#
|
2533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateTransformer AWS API Documentation
|
2534
|
+
#
|
2535
|
+
# @overload update_transformer(params = {})
|
2536
|
+
# @param [Hash] params ({})
|
2537
|
+
def update_transformer(params = {}, options = {})
|
2538
|
+
req = build_request(:update_transformer, params)
|
2539
|
+
req.send_request(options)
|
2540
|
+
end
|
2541
|
+
|
2542
|
+
# @!endgroup
|
2543
|
+
|
2544
|
+
# @param params ({})
|
2545
|
+
# @api private
|
2546
|
+
def build_request(operation_name, params = {})
|
2547
|
+
handlers = @handlers.for(operation_name)
|
2548
|
+
context = Seahorse::Client::RequestContext.new(
|
2549
|
+
operation_name: operation_name,
|
2550
|
+
operation: config.api.operation(operation_name),
|
2551
|
+
client: self,
|
2552
|
+
params: params,
|
2553
|
+
config: config)
|
2554
|
+
context[:gem_name] = 'aws-sdk-b2bi'
|
2555
|
+
context[:gem_version] = '1.0.0'
|
2556
|
+
Seahorse::Client::Request.new(handlers, context)
|
2557
|
+
end
|
2558
|
+
|
2559
|
+
# @api private
|
2560
|
+
# @deprecated
|
2561
|
+
def waiter_names
|
2562
|
+
[]
|
2563
|
+
end
|
2564
|
+
|
2565
|
+
class << self
|
2566
|
+
|
2567
|
+
# @api private
|
2568
|
+
attr_reader :identifier
|
2569
|
+
|
2570
|
+
# @api private
|
2571
|
+
def errors_module
|
2572
|
+
Errors
|
2573
|
+
end
|
2574
|
+
|
2575
|
+
end
|
2576
|
+
end
|
2577
|
+
end
|