aws-sdk-ssmquicksetup 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.
@@ -0,0 +1,882 @@
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/invocation_id.rb'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
29
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
30
+ require 'aws-sdk-core/plugins/http_checksum.rb'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
+ require 'aws-sdk-core/plugins/request_compression.rb'
33
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
34
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/sign.rb'
36
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
37
+
38
+ Aws::Plugins::GlobalConfiguration.add_identifier(:ssmquicksetup)
39
+
40
+ module Aws::SSMQuickSetup
41
+ # An API client for SSMQuickSetup. To construct a client, you need to configure a `:region` and `:credentials`.
42
+ #
43
+ # client = Aws::SSMQuickSetup::Client.new(
44
+ # region: region_name,
45
+ # credentials: credentials,
46
+ # # ...
47
+ # )
48
+ #
49
+ # For details on configuring region and credentials see
50
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
51
+ #
52
+ # See {#initialize} for a full list of supported configuration options.
53
+ class Client < Seahorse::Client::Base
54
+
55
+ include Aws::ClientStubs
56
+
57
+ @identifier = :ssmquicksetup
58
+
59
+ set_api(ClientApi::API)
60
+
61
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
62
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
63
+ add_plugin(Aws::Plugins::Logging)
64
+ add_plugin(Aws::Plugins::ParamConverter)
65
+ add_plugin(Aws::Plugins::ParamValidator)
66
+ add_plugin(Aws::Plugins::UserAgent)
67
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
68
+ add_plugin(Aws::Plugins::RetryErrors)
69
+ add_plugin(Aws::Plugins::GlobalConfiguration)
70
+ add_plugin(Aws::Plugins::RegionalEndpoint)
71
+ add_plugin(Aws::Plugins::EndpointDiscovery)
72
+ add_plugin(Aws::Plugins::EndpointPattern)
73
+ add_plugin(Aws::Plugins::ResponsePaging)
74
+ add_plugin(Aws::Plugins::StubResponses)
75
+ add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
77
+ add_plugin(Aws::Plugins::JsonvalueConverter)
78
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
79
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
80
+ add_plugin(Aws::Plugins::TransferEncoding)
81
+ add_plugin(Aws::Plugins::HttpChecksum)
82
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
83
+ add_plugin(Aws::Plugins::RequestCompression)
84
+ add_plugin(Aws::Plugins::DefaultsMode)
85
+ add_plugin(Aws::Plugins::RecursionDetection)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::SSMQuickSetup::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials. This can be an instance of any one of the
99
+ # following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following
128
+ # locations will be searched for credentials:
129
+ #
130
+ # * `Aws.config[:credentials]`
131
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
132
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
136
+ # are very aggressive. Construct and pass an instance of
137
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
138
+ # enable retries and extended timeouts. Instance profile credential
139
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
140
+ # to true.
141
+ #
142
+ # @option options [required, String] :region
143
+ # The AWS region to connect to. The configured `:region` is
144
+ # used to determine the service `:endpoint`. When not passed,
145
+ # a default `:region` is searched for in the following locations:
146
+ #
147
+ # * `Aws.config[:region]`
148
+ # * `ENV['AWS_REGION']`
149
+ # * `ENV['AMAZON_REGION']`
150
+ # * `ENV['AWS_DEFAULT_REGION']`
151
+ # * `~/.aws/credentials`
152
+ # * `~/.aws/config`
153
+ #
154
+ # @option options [String] :access_key_id
155
+ #
156
+ # @option options [Boolean] :active_endpoint_cache (false)
157
+ # When set to `true`, a thread polling for endpoints will be running in
158
+ # the background every 60 secs (default). Defaults to `false`.
159
+ #
160
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
161
+ # Used only in `adaptive` retry mode. When true, the request will sleep
162
+ # until there is sufficent client side capacity to retry the request.
163
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
164
+ # not retry instead of sleeping.
165
+ #
166
+ # @option options [Boolean] :client_side_monitoring (false)
167
+ # When `true`, client-side metrics will be collected for all API requests from
168
+ # this client.
169
+ #
170
+ # @option options [String] :client_side_monitoring_client_id ("")
171
+ # Allows you to provide an identifier for this client which will be attached to
172
+ # all generated client side metrics. Defaults to an empty string.
173
+ #
174
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
175
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
176
+ # side monitoring agent is running on, where client metrics will be published via UDP.
177
+ #
178
+ # @option options [Integer] :client_side_monitoring_port (31000)
179
+ # Required for publishing client metrics. The port that the client side monitoring
180
+ # agent is running on, where client metrics will be published via UDP.
181
+ #
182
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
183
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
184
+ # will use the Client Side Monitoring Agent Publisher.
185
+ #
186
+ # @option options [Boolean] :convert_params (true)
187
+ # When `true`, an attempt is made to coerce request parameters into
188
+ # the required types.
189
+ #
190
+ # @option options [Boolean] :correct_clock_skew (true)
191
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
192
+ # a clock skew correction and retry requests with skewed client clocks.
193
+ #
194
+ # @option options [String] :defaults_mode ("legacy")
195
+ # See {Aws::DefaultsModeConfiguration} for a list of the
196
+ # accepted modes and the configuration defaults that are included.
197
+ #
198
+ # @option options [Boolean] :disable_host_prefix_injection (false)
199
+ # Set to true to disable SDK automatically adding host prefix
200
+ # to default service endpoint when available.
201
+ #
202
+ # @option options [Boolean] :disable_request_compression (false)
203
+ # When set to 'true' the request body will not be compressed
204
+ # for supported operations.
205
+ #
206
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
207
+ # Normally you should not configure the `:endpoint` option
208
+ # directly. This is normally constructed from the `:region`
209
+ # option. Configuring `:endpoint` is normally reserved for
210
+ # connecting to test or custom endpoints. The endpoint should
211
+ # be a URI formatted like:
212
+ #
213
+ # 'http://example.com'
214
+ # 'https://example.com'
215
+ # 'http://example.com:123'
216
+ #
217
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
218
+ # Used for the maximum size limit of the LRU cache storing endpoints data
219
+ # for endpoint discovery enabled operations. Defaults to 1000.
220
+ #
221
+ # @option options [Integer] :endpoint_cache_max_threads (10)
222
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
223
+ #
224
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
225
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
226
+ # Use this option to config the time interval in seconds for making
227
+ # requests fetching endpoints information. Defaults to 60 sec.
228
+ #
229
+ # @option options [Boolean] :endpoint_discovery (false)
230
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
231
+ #
232
+ # @option options [Boolean] :ignore_configured_endpoint_urls
233
+ # Setting to true disables use of endpoint URLs provided via environment
234
+ # variables and the shared configuration file.
235
+ #
236
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
237
+ # The log formatter.
238
+ #
239
+ # @option options [Symbol] :log_level (:info)
240
+ # The log level to send messages to the `:logger` at.
241
+ #
242
+ # @option options [Logger] :logger
243
+ # The Logger instance to send log messages to. If this option
244
+ # is not set, logging will be disabled.
245
+ #
246
+ # @option options [Integer] :max_attempts (3)
247
+ # An integer representing the maximum number attempts that will be made for
248
+ # a single request, including the initial attempt. For example,
249
+ # setting this value to 5 will result in a request being retried up to
250
+ # 4 times. Used in `standard` and `adaptive` retry modes.
251
+ #
252
+ # @option options [String] :profile ("default")
253
+ # Used when loading credentials from the shared credentials file
254
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
255
+ #
256
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
257
+ # The minimum size in bytes that triggers compression for request
258
+ # bodies. The value must be non-negative integer value between 0
259
+ # and 10485780 bytes inclusive.
260
+ #
261
+ # @option options [Proc] :retry_backoff
262
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
263
+ # This option is only used in the `legacy` retry mode.
264
+ #
265
+ # @option options [Float] :retry_base_delay (0.3)
266
+ # The base delay in seconds used by the default backoff function. This option
267
+ # is only used in the `legacy` retry mode.
268
+ #
269
+ # @option options [Symbol] :retry_jitter (:none)
270
+ # A delay randomiser function used by the default backoff function.
271
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
272
+ # otherwise a Proc that takes and returns a number. This option is only used
273
+ # in the `legacy` retry mode.
274
+ #
275
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
276
+ #
277
+ # @option options [Integer] :retry_limit (3)
278
+ # The maximum number of times to retry failed requests. Only
279
+ # ~ 500 level server errors and certain ~ 400 level client errors
280
+ # are retried. Generally, these are throttling errors, data
281
+ # checksum errors, networking errors, timeout errors, auth errors,
282
+ # endpoint discovery, and errors from expired credentials.
283
+ # This option is only used in the `legacy` retry mode.
284
+ #
285
+ # @option options [Integer] :retry_max_delay (0)
286
+ # The maximum number of seconds to delay between retries (0 for no limit)
287
+ # used by the default backoff function. This option is only used in the
288
+ # `legacy` retry mode.
289
+ #
290
+ # @option options [String] :retry_mode ("legacy")
291
+ # Specifies which retry algorithm to use. Values are:
292
+ #
293
+ # * `legacy` - The pre-existing retry behavior. This is default value if
294
+ # no retry mode is provided.
295
+ #
296
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
297
+ # This includes support for retry quotas, which limit the number of
298
+ # unsuccessful retries a client can make.
299
+ #
300
+ # * `adaptive` - An experimental retry mode that includes all the
301
+ # functionality of `standard` mode along with automatic client side
302
+ # throttling. This is a provisional mode that may change behavior
303
+ # in the future.
304
+ #
305
+ # @option options [String] :sdk_ua_app_id
306
+ # A unique and opaque application ID that is appended to the
307
+ # User-Agent header as app/sdk_ua_app_id. It should have a
308
+ # maximum length of 50. This variable is sourced from environment
309
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
310
+ #
311
+ # @option options [String] :secret_access_key
312
+ #
313
+ # @option options [String] :session_token
314
+ #
315
+ # @option options [Array] :sigv4a_signing_region_set
316
+ # A list of regions that should be signed with SigV4a signing. When
317
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
318
+ # in the following locations:
319
+ #
320
+ # * `Aws.config[:sigv4a_signing_region_set]`
321
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
322
+ # * `~/.aws/config`
323
+ #
324
+ # @option options [Boolean] :stub_responses (false)
325
+ # Causes the client to return stubbed responses. By default
326
+ # fake responses are generated and returned. You can specify
327
+ # the response data to return or errors to raise by calling
328
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
329
+ #
330
+ # ** Please note ** When response stubbing is enabled, no HTTP
331
+ # requests are made, and retries are disabled.
332
+ #
333
+ # @option options [Aws::TokenProvider] :token_provider
334
+ # A Bearer Token Provider. This can be an instance of any one of the
335
+ # following classes:
336
+ #
337
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
338
+ # tokens.
339
+ #
340
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
341
+ # access token generated from `aws login`.
342
+ #
343
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
344
+ # will be used to search for tokens configured for your profile in shared configuration files.
345
+ #
346
+ # @option options [Boolean] :use_dualstack_endpoint
347
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
348
+ # will be used if available.
349
+ #
350
+ # @option options [Boolean] :use_fips_endpoint
351
+ # When set to `true`, fips compatible endpoints will be used if available.
352
+ # When a `fips` region is used, the region is normalized and this config
353
+ # is set to `true`.
354
+ #
355
+ # @option options [Boolean] :validate_params (true)
356
+ # When `true`, request parameters are validated before
357
+ # sending the request.
358
+ #
359
+ # @option options [Aws::SSMQuickSetup::EndpointProvider] :endpoint_provider
360
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SSMQuickSetup::EndpointParameters`
361
+ #
362
+ # @option options [Float] :http_continue_timeout (1)
363
+ # The number of seconds to wait for a 100-continue response before sending the
364
+ # request body. This option has no effect unless the request has "Expect"
365
+ # header set to "100-continue". Defaults to `nil` which disables this
366
+ # behaviour. This value can safely be set per request on the session.
367
+ #
368
+ # @option options [Float] :http_idle_timeout (5)
369
+ # The number of seconds a connection is allowed to sit idle before it
370
+ # is considered stale. Stale connections are closed and removed from the
371
+ # pool before making a request.
372
+ #
373
+ # @option options [Float] :http_open_timeout (15)
374
+ # The default number of seconds to wait for response data.
375
+ # This value can safely be set per-request on the session.
376
+ #
377
+ # @option options [URI::HTTP,String] :http_proxy
378
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
379
+ #
380
+ # @option options [Float] :http_read_timeout (60)
381
+ # The default number of seconds to wait for response data.
382
+ # This value can safely be set per-request on the session.
383
+ #
384
+ # @option options [Boolean] :http_wire_trace (false)
385
+ # When `true`, HTTP debug output will be sent to the `:logger`.
386
+ #
387
+ # @option options [Proc] :on_chunk_received
388
+ # When a Proc object is provided, it will be used as callback when each chunk
389
+ # of the response body is received. It provides three arguments: the chunk,
390
+ # the number of bytes received, and the total number of
391
+ # bytes in the response (or nil if the server did not send a `content-length`).
392
+ #
393
+ # @option options [Proc] :on_chunk_sent
394
+ # When a Proc object is provided, it will be used as callback when each chunk
395
+ # of the request body is sent. It provides three arguments: the chunk,
396
+ # the number of bytes read from the body, and the total number of
397
+ # bytes in the body.
398
+ #
399
+ # @option options [Boolean] :raise_response_errors (true)
400
+ # When `true`, response errors are raised.
401
+ #
402
+ # @option options [String] :ssl_ca_bundle
403
+ # Full path to the SSL certificate authority bundle file that should be used when
404
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
405
+ # `:ssl_ca_directory` the the system default will be used if available.
406
+ #
407
+ # @option options [String] :ssl_ca_directory
408
+ # Full path of the directory that contains the unbundled SSL certificate
409
+ # authority files for verifying peer certificates. If you do
410
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
411
+ # default will be used if available.
412
+ #
413
+ # @option options [String] :ssl_ca_store
414
+ # Sets the X509::Store to verify peer certificate.
415
+ #
416
+ # @option options [Float] :ssl_timeout
417
+ # Sets the SSL timeout in seconds
418
+ #
419
+ # @option options [Boolean] :ssl_verify_peer (true)
420
+ # When `true`, SSL peer certificates are verified when establishing a connection.
421
+ #
422
+ def initialize(*args)
423
+ super
424
+ end
425
+
426
+ # @!group API Operations
427
+
428
+ # Creates a Quick Setup configuration manager resource. This object is a
429
+ # collection of desired state configurations for multiple configuration
430
+ # definitions and summaries describing the deployments of those
431
+ # definitions.
432
+ #
433
+ # @option params [required, Array<Types::ConfigurationDefinitionInput>] :configuration_definitions
434
+ # The definition of the Quick Setup configuration that the configuration
435
+ # manager deploys.
436
+ #
437
+ # @option params [String] :description
438
+ # A description of the configuration manager.
439
+ #
440
+ # @option params [String] :name
441
+ # A name for the configuration manager.
442
+ #
443
+ # @option params [Hash<String,String>] :tags
444
+ # Key-value pairs of metadata to assign to the configuration manager.
445
+ #
446
+ # @return [Types::CreateConfigurationManagerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
447
+ #
448
+ # * {Types::CreateConfigurationManagerOutput#manager_arn #manager_arn} => String
449
+ #
450
+ # @example Request syntax with placeholder values
451
+ #
452
+ # resp = client.create_configuration_manager({
453
+ # configuration_definitions: [ # required
454
+ # {
455
+ # local_deployment_administration_role_arn: "IAMRoleArn",
456
+ # local_deployment_execution_role_name: "ConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString",
457
+ # parameters: { # required
458
+ # "ConfigurationParametersMapKeyString" => "ConfigurationParametersMapValueString",
459
+ # },
460
+ # type: "ConfigurationDefinitionInputTypeString", # required
461
+ # type_version: "ConfigurationDefinitionInputTypeVersionString",
462
+ # },
463
+ # ],
464
+ # description: "CreateConfigurationManagerInputDescriptionString",
465
+ # name: "CreateConfigurationManagerInputNameString",
466
+ # tags: {
467
+ # "TagsMapKeyString" => "TagsMapValueString",
468
+ # },
469
+ # })
470
+ #
471
+ # @example Response structure
472
+ #
473
+ # resp.manager_arn #=> String
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/CreateConfigurationManager AWS API Documentation
476
+ #
477
+ # @overload create_configuration_manager(params = {})
478
+ # @param [Hash] params ({})
479
+ def create_configuration_manager(params = {}, options = {})
480
+ req = build_request(:create_configuration_manager, params)
481
+ req.send_request(options)
482
+ end
483
+
484
+ # Deletes a configuration manager.
485
+ #
486
+ # @option params [required, String] :manager_arn
487
+ # The ID of the configuration manager.
488
+ #
489
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
490
+ #
491
+ # @example Request syntax with placeholder values
492
+ #
493
+ # resp = client.delete_configuration_manager({
494
+ # manager_arn: "DeleteConfigurationManagerInputManagerArnString", # required
495
+ # })
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/DeleteConfigurationManager AWS API Documentation
498
+ #
499
+ # @overload delete_configuration_manager(params = {})
500
+ # @param [Hash] params ({})
501
+ def delete_configuration_manager(params = {}, options = {})
502
+ req = build_request(:delete_configuration_manager, params)
503
+ req.send_request(options)
504
+ end
505
+
506
+ # Returns a configuration manager.
507
+ #
508
+ # @option params [required, String] :manager_arn
509
+ # The ARN of the configuration manager.
510
+ #
511
+ # @return [Types::GetConfigurationManagerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
512
+ #
513
+ # * {Types::GetConfigurationManagerOutput#configuration_definitions #configuration_definitions} => Array&lt;Types::ConfigurationDefinition&gt;
514
+ # * {Types::GetConfigurationManagerOutput#created_at #created_at} => Time
515
+ # * {Types::GetConfigurationManagerOutput#description #description} => String
516
+ # * {Types::GetConfigurationManagerOutput#last_modified_at #last_modified_at} => Time
517
+ # * {Types::GetConfigurationManagerOutput#manager_arn #manager_arn} => String
518
+ # * {Types::GetConfigurationManagerOutput#name #name} => String
519
+ # * {Types::GetConfigurationManagerOutput#status_summaries #status_summaries} => Array&lt;Types::StatusSummary&gt;
520
+ # * {Types::GetConfigurationManagerOutput#tags #tags} => Hash&lt;String,String&gt;
521
+ #
522
+ # @example Request syntax with placeholder values
523
+ #
524
+ # resp = client.get_configuration_manager({
525
+ # manager_arn: "GetConfigurationManagerInputManagerArnString", # required
526
+ # })
527
+ #
528
+ # @example Response structure
529
+ #
530
+ # resp.configuration_definitions #=> Array
531
+ # resp.configuration_definitions[0].id #=> String
532
+ # resp.configuration_definitions[0].local_deployment_administration_role_arn #=> String
533
+ # resp.configuration_definitions[0].local_deployment_execution_role_name #=> String
534
+ # resp.configuration_definitions[0].parameters #=> Hash
535
+ # resp.configuration_definitions[0].parameters["ConfigurationParametersMapKeyString"] #=> String
536
+ # resp.configuration_definitions[0].type #=> String
537
+ # resp.configuration_definitions[0].type_version #=> String
538
+ # resp.created_at #=> Time
539
+ # resp.description #=> String
540
+ # resp.last_modified_at #=> Time
541
+ # resp.manager_arn #=> String
542
+ # resp.name #=> String
543
+ # resp.status_summaries #=> Array
544
+ # resp.status_summaries[0].last_updated_at #=> Time
545
+ # resp.status_summaries[0].status #=> String, one of "INITIALIZING", "DEPLOYING", "SUCCEEDED", "DELETING", "STOPPING", "FAILED", "STOPPED", "DELETE_FAILED", "STOP_FAILED", "NONE"
546
+ # resp.status_summaries[0].status_details #=> Hash
547
+ # resp.status_summaries[0].status_details["String"] #=> String
548
+ # resp.status_summaries[0].status_message #=> String
549
+ # resp.status_summaries[0].status_type #=> String, one of "Deployment", "AsyncExecutions"
550
+ # resp.tags #=> Hash
551
+ # resp.tags["TagsMapKeyString"] #=> String
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/GetConfigurationManager AWS API Documentation
554
+ #
555
+ # @overload get_configuration_manager(params = {})
556
+ # @param [Hash] params ({})
557
+ def get_configuration_manager(params = {}, options = {})
558
+ req = build_request(:get_configuration_manager, params)
559
+ req.send_request(options)
560
+ end
561
+
562
+ # Returns settings configured for Quick Setup in the requesting Amazon
563
+ # Web Services account and Amazon Web Services Region.
564
+ #
565
+ # @return [Types::GetServiceSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
566
+ #
567
+ # * {Types::GetServiceSettingsOutput#service_settings #service_settings} => Types::ServiceSettings
568
+ #
569
+ # @example Response structure
570
+ #
571
+ # resp.service_settings.explorer_enabling_role_arn #=> String
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/GetServiceSettings AWS API Documentation
574
+ #
575
+ # @overload get_service_settings(params = {})
576
+ # @param [Hash] params ({})
577
+ def get_service_settings(params = {}, options = {})
578
+ req = build_request(:get_service_settings, params)
579
+ req.send_request(options)
580
+ end
581
+
582
+ # Returns Quick Setup configuration managers.
583
+ #
584
+ # @option params [Array<Types::Filter>] :filters
585
+ # Filters the results returned by the request.
586
+ #
587
+ # @option params [Integer] :max_items
588
+ # Specifies the maximum number of configuration managers that are
589
+ # returned by the request.
590
+ #
591
+ # @option params [String] :starting_token
592
+ # The token to use when requesting a specific set of items from a list.
593
+ #
594
+ # @return [Types::ListConfigurationManagersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
595
+ #
596
+ # * {Types::ListConfigurationManagersOutput#configuration_managers_list #configuration_managers_list} => Array&lt;Types::ConfigurationManagerSummary&gt;
597
+ # * {Types::ListConfigurationManagersOutput#next_token #next_token} => String
598
+ #
599
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
600
+ #
601
+ # @example Request syntax with placeholder values
602
+ #
603
+ # resp = client.list_configuration_managers({
604
+ # filters: [
605
+ # {
606
+ # key: "FilterKeyString", # required
607
+ # values: ["FilterValuesMemberString"], # required
608
+ # },
609
+ # ],
610
+ # max_items: 1,
611
+ # starting_token: "ListConfigurationManagersInputStartingTokenString",
612
+ # })
613
+ #
614
+ # @example Response structure
615
+ #
616
+ # resp.configuration_managers_list #=> Array
617
+ # resp.configuration_managers_list[0].configuration_definition_summaries #=> Array
618
+ # resp.configuration_managers_list[0].configuration_definition_summaries[0].first_class_parameters #=> Hash
619
+ # resp.configuration_managers_list[0].configuration_definition_summaries[0].first_class_parameters["ConfigurationParametersMapKeyString"] #=> String
620
+ # resp.configuration_managers_list[0].configuration_definition_summaries[0].id #=> String
621
+ # resp.configuration_managers_list[0].configuration_definition_summaries[0].type #=> String
622
+ # resp.configuration_managers_list[0].configuration_definition_summaries[0].type_version #=> String
623
+ # resp.configuration_managers_list[0].description #=> String
624
+ # resp.configuration_managers_list[0].manager_arn #=> String
625
+ # resp.configuration_managers_list[0].name #=> String
626
+ # resp.configuration_managers_list[0].status_summaries #=> Array
627
+ # resp.configuration_managers_list[0].status_summaries[0].last_updated_at #=> Time
628
+ # resp.configuration_managers_list[0].status_summaries[0].status #=> String, one of "INITIALIZING", "DEPLOYING", "SUCCEEDED", "DELETING", "STOPPING", "FAILED", "STOPPED", "DELETE_FAILED", "STOP_FAILED", "NONE"
629
+ # resp.configuration_managers_list[0].status_summaries[0].status_details #=> Hash
630
+ # resp.configuration_managers_list[0].status_summaries[0].status_details["String"] #=> String
631
+ # resp.configuration_managers_list[0].status_summaries[0].status_message #=> String
632
+ # resp.configuration_managers_list[0].status_summaries[0].status_type #=> String, one of "Deployment", "AsyncExecutions"
633
+ # resp.next_token #=> String
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/ListConfigurationManagers AWS API Documentation
636
+ #
637
+ # @overload list_configuration_managers(params = {})
638
+ # @param [Hash] params ({})
639
+ def list_configuration_managers(params = {}, options = {})
640
+ req = build_request(:list_configuration_managers, params)
641
+ req.send_request(options)
642
+ end
643
+
644
+ # Returns the available Quick Setup types.
645
+ #
646
+ # @return [Types::ListQuickSetupTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
647
+ #
648
+ # * {Types::ListQuickSetupTypesOutput#quick_setup_type_list #quick_setup_type_list} => Array&lt;Types::QuickSetupTypeOutput&gt;
649
+ #
650
+ # @example Response structure
651
+ #
652
+ # resp.quick_setup_type_list #=> Array
653
+ # resp.quick_setup_type_list[0].latest_version #=> String
654
+ # resp.quick_setup_type_list[0].type #=> String
655
+ #
656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/ListQuickSetupTypes AWS API Documentation
657
+ #
658
+ # @overload list_quick_setup_types(params = {})
659
+ # @param [Hash] params ({})
660
+ def list_quick_setup_types(params = {}, options = {})
661
+ req = build_request(:list_quick_setup_types, params)
662
+ req.send_request(options)
663
+ end
664
+
665
+ # Returns tags assigned to the resource.
666
+ #
667
+ # @option params [required, String] :resource_arn
668
+ # The ARN of the resource the tag is assigned to.
669
+ #
670
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
671
+ #
672
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::TagEntry&gt;
673
+ #
674
+ # @example Request syntax with placeholder values
675
+ #
676
+ # resp = client.list_tags_for_resource({
677
+ # resource_arn: "String", # required
678
+ # })
679
+ #
680
+ # @example Response structure
681
+ #
682
+ # resp.tags #=> Array
683
+ # resp.tags[0].key #=> String
684
+ # resp.tags[0].value #=> String
685
+ #
686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/ListTagsForResource AWS API Documentation
687
+ #
688
+ # @overload list_tags_for_resource(params = {})
689
+ # @param [Hash] params ({})
690
+ def list_tags_for_resource(params = {}, options = {})
691
+ req = build_request(:list_tags_for_resource, params)
692
+ req.send_request(options)
693
+ end
694
+
695
+ # Assigns key-value pairs of metadata to Amazon Web Services resources.
696
+ #
697
+ # @option params [required, String] :resource_arn
698
+ # The ARN of the resource to tag.
699
+ #
700
+ # @option params [required, Hash<String,String>] :tags
701
+ # Key-value pairs of metadata to assign to the resource.
702
+ #
703
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
704
+ #
705
+ # @example Request syntax with placeholder values
706
+ #
707
+ # resp = client.tag_resource({
708
+ # resource_arn: "String", # required
709
+ # tags: { # required
710
+ # "TagsMapKeyString" => "TagsMapValueString",
711
+ # },
712
+ # })
713
+ #
714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/TagResource AWS API Documentation
715
+ #
716
+ # @overload tag_resource(params = {})
717
+ # @param [Hash] params ({})
718
+ def tag_resource(params = {}, options = {})
719
+ req = build_request(:tag_resource, params)
720
+ req.send_request(options)
721
+ end
722
+
723
+ # Removes tags from the specified resource.
724
+ #
725
+ # @option params [required, String] :resource_arn
726
+ # The ARN of the resource to remove tags from.
727
+ #
728
+ # @option params [required, Array<String>] :tag_keys
729
+ # The keys of the tags to remove from the resource.
730
+ #
731
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
732
+ #
733
+ # @example Request syntax with placeholder values
734
+ #
735
+ # resp = client.untag_resource({
736
+ # resource_arn: "String", # required
737
+ # tag_keys: ["String"], # required
738
+ # })
739
+ #
740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/UntagResource AWS API Documentation
741
+ #
742
+ # @overload untag_resource(params = {})
743
+ # @param [Hash] params ({})
744
+ def untag_resource(params = {}, options = {})
745
+ req = build_request(:untag_resource, params)
746
+ req.send_request(options)
747
+ end
748
+
749
+ # Updates a Quick Setup configuration definition.
750
+ #
751
+ # @option params [required, String] :id
752
+ # The ID of the configuration definition you want to update.
753
+ #
754
+ # @option params [String] :local_deployment_administration_role_arn
755
+ # The ARN of the IAM role used to administrate local configuration
756
+ # deployments.
757
+ #
758
+ # @option params [String] :local_deployment_execution_role_name
759
+ # The name of the IAM role used to deploy local configurations.
760
+ #
761
+ # @option params [required, String] :manager_arn
762
+ # The ARN of the configuration manager associated with the definition to
763
+ # update.
764
+ #
765
+ # @option params [Hash<String,String>] :parameters
766
+ # The parameters for the configuration definition type.
767
+ #
768
+ # @option params [String] :type_version
769
+ # The version of the Quick Setup type to use.
770
+ #
771
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
772
+ #
773
+ # @example Request syntax with placeholder values
774
+ #
775
+ # resp = client.update_configuration_definition({
776
+ # id: "UpdateConfigurationDefinitionInputIdString", # required
777
+ # local_deployment_administration_role_arn: "IAMRoleArn",
778
+ # local_deployment_execution_role_name: "UpdateConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString",
779
+ # manager_arn: "UpdateConfigurationDefinitionInputManagerArnString", # required
780
+ # parameters: {
781
+ # "ConfigurationParametersMapKeyString" => "ConfigurationParametersMapValueString",
782
+ # },
783
+ # type_version: "UpdateConfigurationDefinitionInputTypeVersionString",
784
+ # })
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/UpdateConfigurationDefinition AWS API Documentation
787
+ #
788
+ # @overload update_configuration_definition(params = {})
789
+ # @param [Hash] params ({})
790
+ def update_configuration_definition(params = {}, options = {})
791
+ req = build_request(:update_configuration_definition, params)
792
+ req.send_request(options)
793
+ end
794
+
795
+ # Updates a Quick Setup configuration manager.
796
+ #
797
+ # @option params [String] :description
798
+ # A description of the configuration manager.
799
+ #
800
+ # @option params [required, String] :manager_arn
801
+ # The ARN of the configuration manager.
802
+ #
803
+ # @option params [String] :name
804
+ # A name for the configuration manager.
805
+ #
806
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
807
+ #
808
+ # @example Request syntax with placeholder values
809
+ #
810
+ # resp = client.update_configuration_manager({
811
+ # description: "UpdateConfigurationManagerInputDescriptionString",
812
+ # manager_arn: "UpdateConfigurationManagerInputManagerArnString", # required
813
+ # name: "UpdateConfigurationManagerInputNameString",
814
+ # })
815
+ #
816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/UpdateConfigurationManager AWS API Documentation
817
+ #
818
+ # @overload update_configuration_manager(params = {})
819
+ # @param [Hash] params ({})
820
+ def update_configuration_manager(params = {}, options = {})
821
+ req = build_request(:update_configuration_manager, params)
822
+ req.send_request(options)
823
+ end
824
+
825
+ # Updates settings configured for Quick Setup.
826
+ #
827
+ # @option params [String] :explorer_enabling_role_arn
828
+ # The IAM role used to enable Explorer.
829
+ #
830
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
831
+ #
832
+ # @example Request syntax with placeholder values
833
+ #
834
+ # resp = client.update_service_settings({
835
+ # explorer_enabling_role_arn: "IAMRoleArn",
836
+ # })
837
+ #
838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-quicksetup-2018-05-10/UpdateServiceSettings AWS API Documentation
839
+ #
840
+ # @overload update_service_settings(params = {})
841
+ # @param [Hash] params ({})
842
+ def update_service_settings(params = {}, options = {})
843
+ req = build_request(:update_service_settings, params)
844
+ req.send_request(options)
845
+ end
846
+
847
+ # @!endgroup
848
+
849
+ # @param params ({})
850
+ # @api private
851
+ def build_request(operation_name, params = {})
852
+ handlers = @handlers.for(operation_name)
853
+ context = Seahorse::Client::RequestContext.new(
854
+ operation_name: operation_name,
855
+ operation: config.api.operation(operation_name),
856
+ client: self,
857
+ params: params,
858
+ config: config)
859
+ context[:gem_name] = 'aws-sdk-ssmquicksetup'
860
+ context[:gem_version] = '1.0.0'
861
+ Seahorse::Client::Request.new(handlers, context)
862
+ end
863
+
864
+ # @api private
865
+ # @deprecated
866
+ def waiter_names
867
+ []
868
+ end
869
+
870
+ class << self
871
+
872
+ # @api private
873
+ attr_reader :identifier
874
+
875
+ # @api private
876
+ def errors_module
877
+ Errors
878
+ end
879
+
880
+ end
881
+ end
882
+ end