aws-sdk-ssmsap 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,981 @@
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/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:ssmsap)
37
+
38
+ module Aws::SsmSap
39
+ # An API client for SsmSap. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::SsmSap::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :ssmsap
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::SsmSap::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::SsmSap::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SsmSap::EndpointParameters`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # @option params [String] :action_type
372
+ #
373
+ # @option params [String] :source_resource_arn
374
+ #
375
+ # @option params [required, String] :resource_arn
376
+ #
377
+ # @return [Types::DeleteResourcePermissionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
+ #
379
+ # * {Types::DeleteResourcePermissionOutput#policy #policy} => String
380
+ #
381
+ # @example Request syntax with placeholder values
382
+ #
383
+ # resp = client.delete_resource_permission({
384
+ # action_type: "RESTORE", # accepts RESTORE
385
+ # source_resource_arn: "Arn",
386
+ # resource_arn: "Arn", # required
387
+ # })
388
+ #
389
+ # @example Response structure
390
+ #
391
+ # resp.policy #=> String
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/DeleteResourcePermission AWS API Documentation
394
+ #
395
+ # @overload delete_resource_permission(params = {})
396
+ # @param [Hash] params ({})
397
+ def delete_resource_permission(params = {}, options = {})
398
+ req = build_request(:delete_resource_permission, params)
399
+ req.send_request(options)
400
+ end
401
+
402
+ # @option params [required, String] :application_id
403
+ #
404
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
405
+ #
406
+ # @example Request syntax with placeholder values
407
+ #
408
+ # resp = client.deregister_application({
409
+ # application_id: "ApplicationId", # required
410
+ # })
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/DeregisterApplication AWS API Documentation
413
+ #
414
+ # @overload deregister_application(params = {})
415
+ # @param [Hash] params ({})
416
+ def deregister_application(params = {}, options = {})
417
+ req = build_request(:deregister_application, params)
418
+ req.send_request(options)
419
+ end
420
+
421
+ # @option params [String] :application_id
422
+ #
423
+ # @option params [String] :application_arn
424
+ #
425
+ # @return [Types::GetApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
426
+ #
427
+ # * {Types::GetApplicationOutput#application #application} => Types::Application
428
+ # * {Types::GetApplicationOutput#tags #tags} => Hash&lt;String,String&gt;
429
+ #
430
+ # @example Request syntax with placeholder values
431
+ #
432
+ # resp = client.get_application({
433
+ # application_id: "ApplicationId",
434
+ # application_arn: "SsmSapArn",
435
+ # })
436
+ #
437
+ # @example Response structure
438
+ #
439
+ # resp.application.id #=> String
440
+ # resp.application.type #=> String, one of "HANA"
441
+ # resp.application.arn #=> String
442
+ # resp.application.app_registry_arn #=> String
443
+ # resp.application.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "FAILED", "REGISTERING", "DELETING", "UNKNOWN"
444
+ # resp.application.components #=> Array
445
+ # resp.application.components[0] #=> String
446
+ # resp.application.last_updated #=> Time
447
+ # resp.application.status_message #=> String
448
+ # resp.tags #=> Hash
449
+ # resp.tags["TagKey"] #=> String
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/GetApplication AWS API Documentation
452
+ #
453
+ # @overload get_application(params = {})
454
+ # @param [Hash] params ({})
455
+ def get_application(params = {}, options = {})
456
+ req = build_request(:get_application, params)
457
+ req.send_request(options)
458
+ end
459
+
460
+ # @option params [required, String] :application_id
461
+ #
462
+ # @option params [required, String] :component_id
463
+ #
464
+ # @return [Types::GetComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
465
+ #
466
+ # * {Types::GetComponentOutput#component #component} => Types::Component
467
+ #
468
+ # @example Request syntax with placeholder values
469
+ #
470
+ # resp = client.get_component({
471
+ # application_id: "ApplicationId", # required
472
+ # component_id: "ComponentId", # required
473
+ # })
474
+ #
475
+ # @example Response structure
476
+ #
477
+ # resp.component.component_id #=> String
478
+ # resp.component.application_id #=> String
479
+ # resp.component.component_type #=> String, one of "HANA"
480
+ # resp.component.status #=> String, one of "ACTIVATED"
481
+ # resp.component.databases #=> Array
482
+ # resp.component.databases[0] #=> String
483
+ # resp.component.hosts #=> Array
484
+ # resp.component.hosts[0].host_name #=> String
485
+ # resp.component.hosts[0].host_role #=> String, one of "LEADER", "WORKER", "STANDBY", "UNKNOWN"
486
+ # resp.component.hosts[0].host_ip #=> String
487
+ # resp.component.hosts[0].instance_id #=> String
488
+ # resp.component.primary_host #=> String
489
+ # resp.component.last_updated #=> Time
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/GetComponent AWS API Documentation
492
+ #
493
+ # @overload get_component(params = {})
494
+ # @param [Hash] params ({})
495
+ def get_component(params = {}, options = {})
496
+ req = build_request(:get_component, params)
497
+ req.send_request(options)
498
+ end
499
+
500
+ # @option params [String] :application_id
501
+ #
502
+ # @option params [String] :component_id
503
+ #
504
+ # @option params [String] :database_id
505
+ #
506
+ # @option params [String] :database_arn
507
+ #
508
+ # @return [Types::GetDatabaseOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
509
+ #
510
+ # * {Types::GetDatabaseOutput#database #database} => Types::Database
511
+ # * {Types::GetDatabaseOutput#tags #tags} => Hash&lt;String,String&gt;
512
+ #
513
+ # @example Request syntax with placeholder values
514
+ #
515
+ # resp = client.get_database({
516
+ # application_id: "ApplicationId",
517
+ # component_id: "ComponentId",
518
+ # database_id: "DatabaseId",
519
+ # database_arn: "SsmSapArn",
520
+ # })
521
+ #
522
+ # @example Response structure
523
+ #
524
+ # resp.database.application_id #=> String
525
+ # resp.database.component_id #=> String
526
+ # resp.database.credentials #=> Array
527
+ # resp.database.credentials[0].database_name #=> String
528
+ # resp.database.credentials[0].credential_type #=> String, one of "ADMIN"
529
+ # resp.database.credentials[0].secret_id #=> String
530
+ # resp.database.database_id #=> String
531
+ # resp.database.database_name #=> String
532
+ # resp.database.database_type #=> String, one of "SYSTEM", "TENANT"
533
+ # resp.database.arn #=> String
534
+ # resp.database.status #=> String, one of "RUNNING", "STARTING", "STOPPED", "WARNING", "UNKNOWN"
535
+ # resp.database.primary_host #=> String
536
+ # resp.database.sql_port #=> Integer
537
+ # resp.database.last_updated #=> Time
538
+ # resp.tags #=> Hash
539
+ # resp.tags["TagKey"] #=> String
540
+ #
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/GetDatabase AWS API Documentation
542
+ #
543
+ # @overload get_database(params = {})
544
+ # @param [Hash] params ({})
545
+ def get_database(params = {}, options = {})
546
+ req = build_request(:get_database, params)
547
+ req.send_request(options)
548
+ end
549
+
550
+ # @option params [required, String] :operation_id
551
+ #
552
+ # @return [Types::GetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
553
+ #
554
+ # * {Types::GetOperationOutput#operation #operation} => Types::Operation
555
+ #
556
+ # @example Request syntax with placeholder values
557
+ #
558
+ # resp = client.get_operation({
559
+ # operation_id: "OperationId", # required
560
+ # })
561
+ #
562
+ # @example Response structure
563
+ #
564
+ # resp.operation.id #=> String
565
+ # resp.operation.type #=> String
566
+ # resp.operation.status #=> String, one of "INPROGRESS", "SUCCESS", "ERROR"
567
+ # resp.operation.status_message #=> String
568
+ # resp.operation.properties #=> Hash
569
+ # resp.operation.properties["String"] #=> String
570
+ # resp.operation.resource_type #=> String
571
+ # resp.operation.resource_id #=> String
572
+ # resp.operation.resource_arn #=> String
573
+ # resp.operation.start_time #=> Time
574
+ # resp.operation.end_time #=> Time
575
+ # resp.operation.last_updated_time #=> Time
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/GetOperation AWS API Documentation
578
+ #
579
+ # @overload get_operation(params = {})
580
+ # @param [Hash] params ({})
581
+ def get_operation(params = {}, options = {})
582
+ req = build_request(:get_operation, params)
583
+ req.send_request(options)
584
+ end
585
+
586
+ # @option params [String] :action_type
587
+ #
588
+ # @option params [required, String] :resource_arn
589
+ #
590
+ # @return [Types::GetResourcePermissionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
591
+ #
592
+ # * {Types::GetResourcePermissionOutput#policy #policy} => String
593
+ #
594
+ # @example Request syntax with placeholder values
595
+ #
596
+ # resp = client.get_resource_permission({
597
+ # action_type: "RESTORE", # accepts RESTORE
598
+ # resource_arn: "Arn", # required
599
+ # })
600
+ #
601
+ # @example Response structure
602
+ #
603
+ # resp.policy #=> String
604
+ #
605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/GetResourcePermission AWS API Documentation
606
+ #
607
+ # @overload get_resource_permission(params = {})
608
+ # @param [Hash] params ({})
609
+ def get_resource_permission(params = {}, options = {})
610
+ req = build_request(:get_resource_permission, params)
611
+ req.send_request(options)
612
+ end
613
+
614
+ # @option params [String] :next_token
615
+ #
616
+ # @option params [Integer] :max_results
617
+ #
618
+ # @return [Types::ListApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
619
+ #
620
+ # * {Types::ListApplicationsOutput#applications #applications} => Array&lt;Types::ApplicationSummary&gt;
621
+ # * {Types::ListApplicationsOutput#next_token #next_token} => String
622
+ #
623
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
624
+ #
625
+ # @example Request syntax with placeholder values
626
+ #
627
+ # resp = client.list_applications({
628
+ # next_token: "NextToken",
629
+ # max_results: 1,
630
+ # })
631
+ #
632
+ # @example Response structure
633
+ #
634
+ # resp.applications #=> Array
635
+ # resp.applications[0].id #=> String
636
+ # resp.applications[0].type #=> String, one of "HANA"
637
+ # resp.applications[0].arn #=> String
638
+ # resp.applications[0].tags #=> Hash
639
+ # resp.applications[0].tags["TagKey"] #=> String
640
+ # resp.next_token #=> String
641
+ #
642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/ListApplications AWS API Documentation
643
+ #
644
+ # @overload list_applications(params = {})
645
+ # @param [Hash] params ({})
646
+ def list_applications(params = {}, options = {})
647
+ req = build_request(:list_applications, params)
648
+ req.send_request(options)
649
+ end
650
+
651
+ # @option params [String] :application_id
652
+ #
653
+ # @option params [String] :next_token
654
+ #
655
+ # @option params [Integer] :max_results
656
+ #
657
+ # @return [Types::ListComponentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
658
+ #
659
+ # * {Types::ListComponentsOutput#components #components} => Array&lt;Types::ComponentSummary&gt;
660
+ # * {Types::ListComponentsOutput#next_token #next_token} => String
661
+ #
662
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
663
+ #
664
+ # @example Request syntax with placeholder values
665
+ #
666
+ # resp = client.list_components({
667
+ # application_id: "ApplicationId",
668
+ # next_token: "NextToken",
669
+ # max_results: 1,
670
+ # })
671
+ #
672
+ # @example Response structure
673
+ #
674
+ # resp.components #=> Array
675
+ # resp.components[0].application_id #=> String
676
+ # resp.components[0].component_id #=> String
677
+ # resp.components[0].component_type #=> String, one of "HANA"
678
+ # resp.components[0].tags #=> Hash
679
+ # resp.components[0].tags["TagKey"] #=> String
680
+ # resp.next_token #=> String
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/ListComponents AWS API Documentation
683
+ #
684
+ # @overload list_components(params = {})
685
+ # @param [Hash] params ({})
686
+ def list_components(params = {}, options = {})
687
+ req = build_request(:list_components, params)
688
+ req.send_request(options)
689
+ end
690
+
691
+ # @option params [String] :application_id
692
+ #
693
+ # @option params [String] :component_id
694
+ #
695
+ # @option params [String] :next_token
696
+ #
697
+ # @option params [Integer] :max_results
698
+ #
699
+ # @return [Types::ListDatabasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
700
+ #
701
+ # * {Types::ListDatabasesOutput#databases #databases} => Array&lt;Types::DatabaseSummary&gt;
702
+ # * {Types::ListDatabasesOutput#next_token #next_token} => String
703
+ #
704
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
705
+ #
706
+ # @example Request syntax with placeholder values
707
+ #
708
+ # resp = client.list_databases({
709
+ # application_id: "ApplicationId",
710
+ # component_id: "ComponentId",
711
+ # next_token: "NextToken",
712
+ # max_results: 1,
713
+ # })
714
+ #
715
+ # @example Response structure
716
+ #
717
+ # resp.databases #=> Array
718
+ # resp.databases[0].application_id #=> String
719
+ # resp.databases[0].component_id #=> String
720
+ # resp.databases[0].database_id #=> String
721
+ # resp.databases[0].database_type #=> String, one of "SYSTEM", "TENANT"
722
+ # resp.databases[0].arn #=> String
723
+ # resp.databases[0].tags #=> Hash
724
+ # resp.databases[0].tags["TagKey"] #=> String
725
+ # resp.next_token #=> String
726
+ #
727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/ListDatabases AWS API Documentation
728
+ #
729
+ # @overload list_databases(params = {})
730
+ # @param [Hash] params ({})
731
+ def list_databases(params = {}, options = {})
732
+ req = build_request(:list_databases, params)
733
+ req.send_request(options)
734
+ end
735
+
736
+ # @option params [required, String] :resource_arn
737
+ #
738
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
739
+ #
740
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
741
+ #
742
+ # @example Request syntax with placeholder values
743
+ #
744
+ # resp = client.list_tags_for_resource({
745
+ # resource_arn: "SsmSapArn", # required
746
+ # })
747
+ #
748
+ # @example Response structure
749
+ #
750
+ # resp.tags #=> Hash
751
+ # resp.tags["TagKey"] #=> String
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/ListTagsForResource AWS API Documentation
754
+ #
755
+ # @overload list_tags_for_resource(params = {})
756
+ # @param [Hash] params ({})
757
+ def list_tags_for_resource(params = {}, options = {})
758
+ req = build_request(:list_tags_for_resource, params)
759
+ req.send_request(options)
760
+ end
761
+
762
+ # @option params [required, String] :action_type
763
+ #
764
+ # @option params [required, String] :source_resource_arn
765
+ #
766
+ # @option params [required, String] :resource_arn
767
+ #
768
+ # @return [Types::PutResourcePermissionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
769
+ #
770
+ # * {Types::PutResourcePermissionOutput#policy #policy} => String
771
+ #
772
+ # @example Request syntax with placeholder values
773
+ #
774
+ # resp = client.put_resource_permission({
775
+ # action_type: "RESTORE", # required, accepts RESTORE
776
+ # source_resource_arn: "Arn", # required
777
+ # resource_arn: "Arn", # required
778
+ # })
779
+ #
780
+ # @example Response structure
781
+ #
782
+ # resp.policy #=> String
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/PutResourcePermission AWS API Documentation
785
+ #
786
+ # @overload put_resource_permission(params = {})
787
+ # @param [Hash] params ({})
788
+ def put_resource_permission(params = {}, options = {})
789
+ req = build_request(:put_resource_permission, params)
790
+ req.send_request(options)
791
+ end
792
+
793
+ # @option params [required, String] :application_id
794
+ #
795
+ # @option params [required, String] :application_type
796
+ #
797
+ # @option params [required, Array<String>] :instances
798
+ #
799
+ # @option params [String] :sap_instance_number
800
+ #
801
+ # @option params [String] :sid
802
+ #
803
+ # @option params [Hash<String,String>] :tags
804
+ #
805
+ # @option params [required, Array<Types::ApplicationCredential>] :credentials
806
+ #
807
+ # @return [Types::RegisterApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
808
+ #
809
+ # * {Types::RegisterApplicationOutput#application #application} => Types::Application
810
+ # * {Types::RegisterApplicationOutput#operation_id #operation_id} => String
811
+ #
812
+ # @example Request syntax with placeholder values
813
+ #
814
+ # resp = client.register_application({
815
+ # application_id: "ApplicationId", # required
816
+ # application_type: "HANA", # required, accepts HANA
817
+ # instances: ["InstanceId"], # required
818
+ # sap_instance_number: "SAPInstanceNumber",
819
+ # sid: "SID",
820
+ # tags: {
821
+ # "TagKey" => "TagValue",
822
+ # },
823
+ # credentials: [ # required
824
+ # {
825
+ # database_name: "DatabaseName", # required
826
+ # credential_type: "ADMIN", # required, accepts ADMIN
827
+ # secret_id: "SecretId", # required
828
+ # },
829
+ # ],
830
+ # })
831
+ #
832
+ # @example Response structure
833
+ #
834
+ # resp.application.id #=> String
835
+ # resp.application.type #=> String, one of "HANA"
836
+ # resp.application.arn #=> String
837
+ # resp.application.app_registry_arn #=> String
838
+ # resp.application.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "FAILED", "REGISTERING", "DELETING", "UNKNOWN"
839
+ # resp.application.components #=> Array
840
+ # resp.application.components[0] #=> String
841
+ # resp.application.last_updated #=> Time
842
+ # resp.application.status_message #=> String
843
+ # resp.operation_id #=> String
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/RegisterApplication AWS API Documentation
846
+ #
847
+ # @overload register_application(params = {})
848
+ # @param [Hash] params ({})
849
+ def register_application(params = {}, options = {})
850
+ req = build_request(:register_application, params)
851
+ req.send_request(options)
852
+ end
853
+
854
+ # @option params [required, String] :resource_arn
855
+ #
856
+ # @option params [required, Hash<String,String>] :tags
857
+ #
858
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
859
+ #
860
+ # @example Request syntax with placeholder values
861
+ #
862
+ # resp = client.tag_resource({
863
+ # resource_arn: "SsmSapArn", # required
864
+ # tags: { # required
865
+ # "TagKey" => "TagValue",
866
+ # },
867
+ # })
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/TagResource AWS API Documentation
870
+ #
871
+ # @overload tag_resource(params = {})
872
+ # @param [Hash] params ({})
873
+ def tag_resource(params = {}, options = {})
874
+ req = build_request(:tag_resource, params)
875
+ req.send_request(options)
876
+ end
877
+
878
+ # @option params [required, String] :resource_arn
879
+ #
880
+ # @option params [required, Array<String>] :tag_keys
881
+ #
882
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
883
+ #
884
+ # @example Request syntax with placeholder values
885
+ #
886
+ # resp = client.untag_resource({
887
+ # resource_arn: "SsmSapArn", # required
888
+ # tag_keys: ["TagKey"], # required
889
+ # })
890
+ #
891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/UntagResource AWS API Documentation
892
+ #
893
+ # @overload untag_resource(params = {})
894
+ # @param [Hash] params ({})
895
+ def untag_resource(params = {}, options = {})
896
+ req = build_request(:untag_resource, params)
897
+ req.send_request(options)
898
+ end
899
+
900
+ # @option params [required, String] :application_id
901
+ #
902
+ # @option params [Array<Types::ApplicationCredential>] :credentials_to_add_or_update
903
+ #
904
+ # @option params [Array<Types::ApplicationCredential>] :credentials_to_remove
905
+ #
906
+ # @return [Types::UpdateApplicationSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
907
+ #
908
+ # * {Types::UpdateApplicationSettingsOutput#message #message} => String
909
+ # * {Types::UpdateApplicationSettingsOutput#operation_ids #operation_ids} => Array&lt;String&gt;
910
+ #
911
+ # @example Request syntax with placeholder values
912
+ #
913
+ # resp = client.update_application_settings({
914
+ # application_id: "ApplicationId", # required
915
+ # credentials_to_add_or_update: [
916
+ # {
917
+ # database_name: "DatabaseName", # required
918
+ # credential_type: "ADMIN", # required, accepts ADMIN
919
+ # secret_id: "SecretId", # required
920
+ # },
921
+ # ],
922
+ # credentials_to_remove: [
923
+ # {
924
+ # database_name: "DatabaseName", # required
925
+ # credential_type: "ADMIN", # required, accepts ADMIN
926
+ # secret_id: "SecretId", # required
927
+ # },
928
+ # ],
929
+ # })
930
+ #
931
+ # @example Response structure
932
+ #
933
+ # resp.message #=> String
934
+ # resp.operation_ids #=> Array
935
+ # resp.operation_ids[0] #=> String
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssmsap-2018-05-10/UpdateApplicationSettings AWS API Documentation
938
+ #
939
+ # @overload update_application_settings(params = {})
940
+ # @param [Hash] params ({})
941
+ def update_application_settings(params = {}, options = {})
942
+ req = build_request(:update_application_settings, params)
943
+ req.send_request(options)
944
+ end
945
+
946
+ # @!endgroup
947
+
948
+ # @param params ({})
949
+ # @api private
950
+ def build_request(operation_name, params = {})
951
+ handlers = @handlers.for(operation_name)
952
+ context = Seahorse::Client::RequestContext.new(
953
+ operation_name: operation_name,
954
+ operation: config.api.operation(operation_name),
955
+ client: self,
956
+ params: params,
957
+ config: config)
958
+ context[:gem_name] = 'aws-sdk-ssmsap'
959
+ context[:gem_version] = '1.0.0'
960
+ Seahorse::Client::Request.new(handlers, context)
961
+ end
962
+
963
+ # @api private
964
+ # @deprecated
965
+ def waiter_names
966
+ []
967
+ end
968
+
969
+ class << self
970
+
971
+ # @api private
972
+ attr_reader :identifier
973
+
974
+ # @api private
975
+ def errors_module
976
+ Errors
977
+ end
978
+
979
+ end
980
+ end
981
+ end