aws-sdk-support 1.17.0 → 1.22.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 1d906fefaa7dcfc2f17c2e0f0b9cd980c4c391a1
4
- data.tar.gz: 8f8548802aa737b18e6d807880d9441156047356
2
+ SHA256:
3
+ metadata.gz: 641b0b5bc1e7ac861276c6175ce7919fe3ee67a484a5ef15d23079ac2d8f35f6
4
+ data.tar.gz: bf8736e5f839b4edbea819adfb9e1d90af8bd2c2f54c6a0b0a791785be8fb427
5
5
  SHA512:
6
- metadata.gz: 99ee66d841bade7d9c739e31ca186ca2ac03f65d137ccb3612ae1a75d6b97921f618c647f6c4948519d3da43450e4efdcdd51a824c2960160c69f2333f754db6
7
- data.tar.gz: ba19f60a2a73481a984b406b82b5a70a480067427fe753467b9051542d41cb2eb79dc413db67a71ed2ed1a3bfef612b9e65233c45807a0b05e3d0621eecce13e
6
+ metadata.gz: 24b61b8cef3974c639e0a9c9acbb64f7457d1c719c7335f1ea23706fddf7904ef56229f9f66005fade3374e185dc14ba698c140dd7b290cb07b672dd6b41923a
7
+ data.tar.gz: 9fedbdd4a63019ae4d070ec3948a4e83a4b5f802b770dfc8bd997a887ed5d4e43b222cb9ab80dd5a014f4b41091595461f5eede753fe99a34908cad64abfee0f
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-support/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # support = Aws::Support::Client.new
28
+ # resp = support.add_attachments_to_set(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Support all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Support are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Support::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Support API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-support/customizations'
42
45
  # @service
43
46
  module Aws::Support
44
47
 
45
- GEM_VERSION = '1.17.0'
48
+ GEM_VERSION = '1.22.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:support)
31
32
 
32
33
  module Aws::Support
34
+ # An API client for Support. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::Support::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::Support
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::Support
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::Support
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::Support
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::Support
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::Support
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::Support
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::Support
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::Support
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::Support
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -264,17 +320,12 @@ module Aws::Support
264
320
 
265
321
  # @!group API Operations
266
322
 
267
- # Adds one or more attachments to an attachment set. If an
268
- # `attachmentSetId` is not specified, a new attachment set is created,
269
- # and the ID of the set is returned in the response. If an
270
- # `attachmentSetId` is specified, the attachments are added to the
271
- # specified set, if it exists.
272
- #
273
- # An attachment set is a temporary container for attachments that are to
274
- # be added to a case or case communication. The set is available for one
275
- # hour after it is created; the `expiryTime` returned in the response
276
- # indicates when the set expires. The maximum number of attachments in a
277
- # set is 3, and the maximum size of any attachment in the set is 5 MB.
323
+ # Adds one or more attachments to an attachment set.
324
+ #
325
+ # An attachment set is a temporary container for attachments that you
326
+ # add to a case or case communication. The set is available for 1 hour
327
+ # after it's created. The `expiryTime` returned in the response is when
328
+ # the set expires.
278
329
  #
279
330
  # @option params [String] :attachment_set_id
280
331
  # The ID of the attachment set. If an `attachmentSetId` is not
@@ -283,8 +334,14 @@ module Aws::Support
283
334
  # attachments are added to the specified set, if it exists.
284
335
  #
285
336
  # @option params [required, Array<Types::Attachment>] :attachments
286
- # One or more attachments to add to the set. The limit is 3 attachments
287
- # per set, and the size limit is 5 MB per attachment.
337
+ # One or more attachments to add to the set. You can add up to three
338
+ # attachments per set. The size limit is 5 MB per attachment.
339
+ #
340
+ # In the `Attachment` object, use the `data` parameter to specify the
341
+ # contents of the attachment file. In the previous request syntax, the
342
+ # value for `data` appear as `blob`, which is represented as a
343
+ # base64-encoded string. The value for `fileName` is the name of the
344
+ # attachment, such as `troubleshoot-screenshot.png`.
288
345
  #
289
346
  # @return [Types::AddAttachmentsToSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
290
347
  #
@@ -370,122 +427,105 @@ module Aws::Support
370
427
  req.send_request(options)
371
428
  end
372
429
 
373
- # Creates a new case in the AWS Support Center. This operation is
374
- # modeled on the behavior of the AWS Support Center [Create Case][1]
375
- # page. Its parameters require you to specify the following information:
376
- #
377
- # * **issueType.** The type of issue for the case. You can specify
378
- # either "customer-service" or "technical." If you do not indicate
379
- # a value, the default is "technical."
430
+ # Creates a case in the AWS Support Center. This operation is similar to
431
+ # how you create a case in the AWS Support Center [Create Case][1] page.
380
432
  #
381
- # <note markdown="1"> Service limit increases are not supported by the Support API; you
382
- # must submit service limit increase requests in [Support Center][2].
433
+ # The AWS Support API doesn't support requesting service limit
434
+ # increases. You can submit a service limit increase in the following
435
+ # ways:
383
436
  #
384
- # The `caseId` is not the `displayId` that appears in [Support
385
- # Center][2]. You can use the DescribeCases API to get the
386
- # `displayId`.
437
+ # * Submit a request from the AWS Support Center [Create Case][1] page.
387
438
  #
388
- # </note>
389
- #
390
- # * **serviceCode.** The code for an AWS service. You can get the
391
- # possible `serviceCode` values by calling DescribeServices.
392
- #
393
- # * **categoryCode.** The category for the service defined for the
394
- # `serviceCode` value. You also get the category code for a service by
395
- # calling DescribeServices. Each AWS service defines its own set of
396
- # category codes.
397
- #
398
- # * **severityCode.** A value that indicates the urgency of the case,
399
- # which in turn determines the response time according to your service
400
- # level agreement with AWS Support. You can get the possible
401
- # `severityCode` values by calling DescribeSeverityLevels. For more
402
- # information about the meaning of the codes, see SeverityLevel and
403
- # [Choosing a Severity][3].
404
- #
405
- # * **subject.** The **Subject** field on the AWS Support Center [Create
406
- # Case][1] page.
439
+ # * Use the Service Quotas [RequestServiceQuotaIncrease][2] operation.
407
440
  #
408
- # * **communicationBody.** The **Description** field on the AWS Support
409
- # Center [Create Case][1] page.
410
- #
411
- # * **attachmentSetId.** The ID of a set of attachments that has been
412
- # created by using AddAttachmentsToSet.
413
- #
414
- # * **language.** The human language in which AWS Support handles the
415
- # case. English and Japanese are currently supported.
441
+ # A successful CreateCase request returns an AWS Support case number.
442
+ # You can use the DescribeCases operation and specify the case number to
443
+ # get existing AWS Support cases. After you create a case, you can use
444
+ # the AddCommunicationToCase operation to add additional communication
445
+ # or attachments to an existing case.
416
446
  #
417
- # * **ccEmailAddresses.** The AWS Support Center **CC** field on the
418
- # [Create Case][1] page. You can list email addresses to be copied on
419
- # any correspondence about the case. The account that opens the case
420
- # is already identified by passing the AWS Credentials in the HTTP
421
- # POST method or in a method or function call from one of the
422
- # programming languages supported by an [AWS SDK][4].
447
+ # <note markdown="1"> * The `caseId` is separate from the `displayId` that appears in the
448
+ # [Support Center][3]. You can use the DescribeCases operation to get
449
+ # the `displayId`.
423
450
  #
424
- # <note markdown="1"> To add additional communication or attachments to an existing case,
425
- # use AddCommunicationToCase.
451
+ # ^
426
452
  #
427
453
  # </note>
428
454
  #
429
- # A successful CreateCase request returns an AWS Support case number.
430
- # Case numbers are used by the DescribeCases operation to retrieve
431
- # existing AWS Support cases.
432
- #
433
455
  #
434
456
  #
435
457
  # [1]: https://console.aws.amazon.com/support/home#/case/create
436
- # [2]: https://console.aws.amazon.com/support
437
- # [3]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity
438
- # [4]: http://aws.amazon.com/tools/
458
+ # [2]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html
459
+ # [3]: https://console.aws.amazon.com/support
439
460
  #
440
461
  # @option params [required, String] :subject
441
- # The title of the AWS Support case.
462
+ # The title of the AWS Support case. The title appears in the
463
+ # **Subject** field on the AWS Support Center [Create Case][1] page.
464
+ #
465
+ #
466
+ #
467
+ # [1]: https://console.aws.amazon.com/support/home#/case/create
442
468
  #
443
469
  # @option params [String] :service_code
444
- # The code for the AWS service returned by the call to DescribeServices.
470
+ # The code for the AWS service. You can use the DescribeServices
471
+ # operation to get the possible `serviceCode` values.
445
472
  #
446
473
  # @option params [String] :severity_code
447
- # The code for the severity level returned by the call to
448
- # DescribeSeverityLevels.
474
+ # A value that indicates the urgency of the case. This value determines
475
+ # the response time according to your service level agreement with AWS
476
+ # Support. You can use the DescribeSeverityLevels operation to get the
477
+ # possible values for `severityCode`.
478
+ #
479
+ # For more information, see SeverityLevel and [Choosing a Severity][1]
480
+ # in the *AWS Support User Guide*.
449
481
  #
450
482
  # <note markdown="1"> The availability of severity levels depends on the support plan for
451
- # the account.
483
+ # the AWS account.
452
484
  #
453
485
  # </note>
454
486
  #
487
+ #
488
+ #
489
+ # [1]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity
490
+ #
455
491
  # @option params [String] :category_code
456
- # The category of problem for the AWS Support case.
492
+ # The category of problem for the AWS Support case. You also use the
493
+ # DescribeServices operation to get the category code for a service.
494
+ # Each AWS service defines its own set of category codes.
457
495
  #
458
496
  # @option params [required, String] :communication_body
459
- # The communication body text when you create an AWS Support case by
460
- # calling CreateCase.
497
+ # The communication body text that describes the issue. This text
498
+ # appears in the **Description** field on the AWS Support Center [Create
499
+ # Case][1] page.
461
500
  #
462
- # @option params [Array<String>] :cc_email_addresses
463
- # A list of email addresses that AWS Support copies on case
464
- # correspondence.
465
501
  #
466
- # @option params [String] :language
467
- # The ISO 639-1 code for the language in which AWS provides support. AWS
468
- # Support currently supports English ("en") and Japanese ("ja").
469
- # Language parameters must be passed explicitly for operations that take
470
- # them.
471
502
  #
472
- # @option params [String] :issue_type
473
- # The type of issue for the case. You can specify either
474
- # "customer-service" or "technical." If you do not indicate a value,
475
- # the default is "technical."
503
+ # [1]: https://console.aws.amazon.com/support/home#/case/create
476
504
  #
477
- # <note markdown="1"> Service limit increases are not supported by the Support API; you must
478
- # submit service limit increase requests in [Support Center][1].
505
+ # @option params [Array<String>] :cc_email_addresses
506
+ # A list of email addresses that AWS Support copies on case
507
+ # correspondence. AWS Support identifies the account that creates the
508
+ # case when you specify your AWS credentials in an HTTP POST method or
509
+ # use the [AWS SDKs][1].
479
510
  #
480
- # </note>
481
511
  #
482
512
  #
513
+ # [1]: http://aws.amazon.com/tools/
483
514
  #
484
- # [1]: https://console.aws.amazon.com/support
515
+ # @option params [String] :language
516
+ # The language in which AWS Support handles the case. You must specify
517
+ # the ISO 639-1 code for the `language` parameter if you want support in
518
+ # that language. Currently, English ("en") and Japanese ("ja") are
519
+ # supported.
520
+ #
521
+ # @option params [String] :issue_type
522
+ # The type of issue for the case. You can specify `customer-service` or
523
+ # `technical`. If you don't specify a value, the default is
524
+ # `technical`.
485
525
  #
486
526
  # @option params [String] :attachment_set_id
487
527
  # The ID of a set of one or more attachments for the case. Create the
488
- # set by using AddAttachmentsToSet.
528
+ # set by using the AddAttachmentsToSet operation.
489
529
  #
490
530
  # @return [Types::CreateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
491
531
  #
@@ -518,10 +558,11 @@ module Aws::Support
518
558
  req.send_request(options)
519
559
  end
520
560
 
521
- # Returns the attachment that has the specified ID. Attachment IDs are
522
- # generated by the case management system when you add an attachment to
523
- # a case or case communication. Attachment IDs are returned in the
524
- # AttachmentDetails objects that are returned by the
561
+ # Returns the attachment that has the specified ID. Attachments can
562
+ # include screenshots, error logs, or other files that describe your
563
+ # issue. Attachment IDs are generated by the case management system when
564
+ # you add an attachment to a case or case communication. Attachment IDs
565
+ # are returned in the AttachmentDetails objects that are returned by the
525
566
  # DescribeCommunications operation.
526
567
  #
527
568
  # @option params [required, String] :attachment_id
@@ -611,6 +652,8 @@ module Aws::Support
611
652
  # * {Types::DescribeCasesResponse#cases #cases} => Array&lt;Types::CaseDetails&gt;
612
653
  # * {Types::DescribeCasesResponse#next_token #next_token} => String
613
654
  #
655
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
656
+ #
614
657
  # @example Request syntax with placeholder values
615
658
  #
616
659
  # resp = client.describe_cases({
@@ -700,6 +743,8 @@ module Aws::Support
700
743
  # * {Types::DescribeCommunicationsResponse#communications #communications} => Array&lt;Types::Communication&gt;
701
744
  # * {Types::DescribeCommunicationsResponse#next_token #next_token} => String
702
745
  #
746
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
747
+ #
703
748
  # @example Request syntax with placeholder values
704
749
  #
705
750
  # resp = client.describe_communications({
@@ -1127,7 +1172,7 @@ module Aws::Support
1127
1172
  params: params,
1128
1173
  config: config)
1129
1174
  context[:gem_name] = 'aws-sdk-support'
1130
- context[:gem_version] = '1.17.0'
1175
+ context[:gem_version] = '1.22.1'
1131
1176
  Seahorse::Client::Request.new(handlers, context)
1132
1177
  end
1133
1178
 
@@ -6,6 +6,37 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Support
9
+
10
+ # When Support returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Support::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Support errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Support::Errors::ServiceError
18
+ # # rescues all Support API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {AttachmentIdNotFound}
29
+ # * {AttachmentLimitExceeded}
30
+ # * {AttachmentSetExpired}
31
+ # * {AttachmentSetIdNotFound}
32
+ # * {AttachmentSetSizeLimitExceeded}
33
+ # * {CaseCreationLimitExceeded}
34
+ # * {CaseIdNotFound}
35
+ # * {DescribeAttachmentLimitExceeded}
36
+ # * {InternalServerError}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
9
40
  module Errors
10
41
 
11
42
  extend Aws::Errors::DynamicErrors
@@ -23,7 +54,6 @@ module Aws::Support
23
54
  def message
24
55
  @message || @data[:message]
25
56
  end
26
-
27
57
  end
28
58
 
29
59
  class AttachmentLimitExceeded < ServiceError
@@ -39,7 +69,6 @@ module Aws::Support
39
69
  def message
40
70
  @message || @data[:message]
41
71
  end
42
-
43
72
  end
44
73
 
45
74
  class AttachmentSetExpired < ServiceError
@@ -55,7 +84,6 @@ module Aws::Support
55
84
  def message
56
85
  @message || @data[:message]
57
86
  end
58
-
59
87
  end
60
88
 
61
89
  class AttachmentSetIdNotFound < ServiceError
@@ -71,7 +99,6 @@ module Aws::Support
71
99
  def message
72
100
  @message || @data[:message]
73
101
  end
74
-
75
102
  end
76
103
 
77
104
  class AttachmentSetSizeLimitExceeded < ServiceError
@@ -87,7 +114,6 @@ module Aws::Support
87
114
  def message
88
115
  @message || @data[:message]
89
116
  end
90
-
91
117
  end
92
118
 
93
119
  class CaseCreationLimitExceeded < ServiceError
@@ -103,7 +129,6 @@ module Aws::Support
103
129
  def message
104
130
  @message || @data[:message]
105
131
  end
106
-
107
132
  end
108
133
 
109
134
  class CaseIdNotFound < ServiceError
@@ -119,7 +144,6 @@ module Aws::Support
119
144
  def message
120
145
  @message || @data[:message]
121
146
  end
122
-
123
147
  end
124
148
 
125
149
  class DescribeAttachmentLimitExceeded < ServiceError
@@ -135,7 +159,6 @@ module Aws::Support
135
159
  def message
136
160
  @message || @data[:message]
137
161
  end
138
-
139
162
  end
140
163
 
141
164
  class InternalServerError < ServiceError
@@ -151,7 +174,6 @@ module Aws::Support
151
174
  def message
152
175
  @message || @data[:message]
153
176
  end
154
-
155
177
  end
156
178
 
157
179
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Support
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -29,8 +29,14 @@ module Aws::Support
29
29
  # @return [String]
30
30
  #
31
31
  # @!attribute [rw] attachments
32
- # One or more attachments to add to the set. The limit is 3
33
- # attachments per set, and the size limit is 5 MB per attachment.
32
+ # One or more attachments to add to the set. You can add up to three
33
+ # attachments per set. The size limit is 5 MB per attachment.
34
+ #
35
+ # In the `Attachment` object, use the `data` parameter to specify the
36
+ # contents of the attachment file. In the previous request syntax, the
37
+ # value for `data` appear as `blob`, which is represented as a
38
+ # base64-encoded string. The value for `fileName` is the name of the
39
+ # attachment, such as `troubleshoot-screenshot.png`.
34
40
  # @return [Array<Types::Attachment>]
35
41
  #
36
42
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSetRequest AWS API Documentation
@@ -199,7 +205,7 @@ module Aws::Support
199
205
  #
200
206
  # @!attribute [rw] message
201
207
  # The expiration time of the attachment set has passed. The set
202
- # expires 1 hour after it is created.
208
+ # expires one hour after it is created.
203
209
  # @return [String]
204
210
  #
205
211
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentSetExpired AWS API Documentation
@@ -223,11 +229,11 @@ module Aws::Support
223
229
  end
224
230
 
225
231
  # A limit for the size of an attachment set has been exceeded. The
226
- # limits are 3 attachments and 5 MB per attachment.
232
+ # limits are three attachments and 5 MB per attachment.
227
233
  #
228
234
  # @!attribute [rw] message
229
235
  # A limit for the size of an attachment set has been exceeded. The
230
- # limits are 3 attachments and 5 MB per attachment.
236
+ # limits are three attachments and 5 MB per attachment.
231
237
  # @return [String]
232
238
  #
233
239
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentSetSizeLimitExceeded AWS API Documentation
@@ -285,9 +291,20 @@ module Aws::Support
285
291
  # The possible values are: `low`, `normal`, `high`, `urgent`, and
286
292
  # `critical`.
287
293
  #
288
- # * **status.** The status of the case in the AWS Support Center. The
289
- # possible values are: `resolved`, `pending-customer-action`,
290
- # `opened`, `unassigned`, and `work-in-progress`.
294
+ # * **status.** The status of the case in the AWS Support Center. Valid
295
+ # values:
296
+ #
297
+ # * `opened`
298
+ #
299
+ # * `pending-customer-action`
300
+ #
301
+ # * `reopened`
302
+ #
303
+ # * `resolved`
304
+ #
305
+ # * `unassigned`
306
+ #
307
+ # * `work-in-progress`
291
308
  #
292
309
  # * **subject.** The subject line of the case.
293
310
  #
@@ -312,9 +329,21 @@ module Aws::Support
312
329
  # @return [String]
313
330
  #
314
331
  # @!attribute [rw] status
315
- # The status of the case. Valid values: `resolved` \|
316
- # `pending-customer-action` \| `opened` \| `unassigned` \|
317
- # `work-in-progress`.
332
+ # The status of the case.
333
+ #
334
+ # Valid values:
335
+ #
336
+ # * `opened`
337
+ #
338
+ # * `pending-customer-action`
339
+ #
340
+ # * `reopened`
341
+ #
342
+ # * `resolved`
343
+ #
344
+ # * `unassigned`
345
+ #
346
+ # * `work-in-progress`
318
347
  # @return [String]
319
348
  #
320
349
  # @!attribute [rw] service_code
@@ -467,63 +496,81 @@ module Aws::Support
467
496
  # }
468
497
  #
469
498
  # @!attribute [rw] subject
470
- # The title of the AWS Support case.
499
+ # The title of the AWS Support case. The title appears in the
500
+ # **Subject** field on the AWS Support Center [Create Case][1] page.
501
+ #
502
+ #
503
+ #
504
+ # [1]: https://console.aws.amazon.com/support/home#/case/create
471
505
  # @return [String]
472
506
  #
473
507
  # @!attribute [rw] service_code
474
- # The code for the AWS service returned by the call to
475
- # DescribeServices.
508
+ # The code for the AWS service. You can use the DescribeServices
509
+ # operation to get the possible `serviceCode` values.
476
510
  # @return [String]
477
511
  #
478
512
  # @!attribute [rw] severity_code
479
- # The code for the severity level returned by the call to
480
- # DescribeSeverityLevels.
513
+ # A value that indicates the urgency of the case. This value
514
+ # determines the response time according to your service level
515
+ # agreement with AWS Support. You can use the DescribeSeverityLevels
516
+ # operation to get the possible values for `severityCode`.
517
+ #
518
+ # For more information, see SeverityLevel and [Choosing a Severity][1]
519
+ # in the *AWS Support User Guide*.
481
520
  #
482
521
  # <note markdown="1"> The availability of severity levels depends on the support plan for
483
- # the account.
522
+ # the AWS account.
484
523
  #
485
524
  # </note>
525
+ #
526
+ #
527
+ #
528
+ # [1]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity
486
529
  # @return [String]
487
530
  #
488
531
  # @!attribute [rw] category_code
489
- # The category of problem for the AWS Support case.
532
+ # The category of problem for the AWS Support case. You also use the
533
+ # DescribeServices operation to get the category code for a service.
534
+ # Each AWS service defines its own set of category codes.
490
535
  # @return [String]
491
536
  #
492
537
  # @!attribute [rw] communication_body
493
- # The communication body text when you create an AWS Support case by
494
- # calling CreateCase.
538
+ # The communication body text that describes the issue. This text
539
+ # appears in the **Description** field on the AWS Support Center
540
+ # [Create Case][1] page.
541
+ #
542
+ #
543
+ #
544
+ # [1]: https://console.aws.amazon.com/support/home#/case/create
495
545
  # @return [String]
496
546
  #
497
547
  # @!attribute [rw] cc_email_addresses
498
548
  # A list of email addresses that AWS Support copies on case
499
- # correspondence.
549
+ # correspondence. AWS Support identifies the account that creates the
550
+ # case when you specify your AWS credentials in an HTTP POST method or
551
+ # use the [AWS SDKs][1].
552
+ #
553
+ #
554
+ #
555
+ # [1]: http://aws.amazon.com/tools/
500
556
  # @return [Array<String>]
501
557
  #
502
558
  # @!attribute [rw] language
503
- # The ISO 639-1 code for the language in which AWS provides support.
504
- # AWS Support currently supports English ("en") and Japanese
505
- # ("ja"). Language parameters must be passed explicitly for
506
- # operations that take them.
559
+ # The language in which AWS Support handles the case. You must specify
560
+ # the ISO 639-1 code for the `language` parameter if you want support
561
+ # in that language. Currently, English ("en") and Japanese ("ja")
562
+ # are supported.
507
563
  # @return [String]
508
564
  #
509
565
  # @!attribute [rw] issue_type
510
- # The type of issue for the case. You can specify either
511
- # "customer-service" or "technical." If you do not indicate a
512
- # value, the default is "technical."
513
- #
514
- # <note markdown="1"> Service limit increases are not supported by the Support API; you
515
- # must submit service limit increase requests in [Support Center][1].
516
- #
517
- # </note>
518
- #
519
- #
520
- #
521
- # [1]: https://console.aws.amazon.com/support
566
+ # The type of issue for the case. You can specify `customer-service`
567
+ # or `technical`. If you don't specify a value, the default is
568
+ # `technical`.
522
569
  # @return [String]
523
570
  #
524
571
  # @!attribute [rw] attachment_set_id
525
572
  # The ID of a set of one or more attachments for the case. Create the
526
- # set by using AddAttachmentsToSet.
573
+ # set by using the AddAttachmentsToSet operation.
527
574
  # @return [String]
528
575
  #
529
576
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCaseRequest AWS API Documentation
@@ -546,7 +593,7 @@ module Aws::Support
546
593
  #
547
594
  # @!attribute [rw] case_id
548
595
  # The AWS Support case ID requested or returned in the call. The case
549
- # ID is an alphanumeric string formatted as shown in this example:
596
+ # ID is an alphanumeric string in the following format:
550
597
  # case-*12345678910-2013-c4c1d2bf33c5cf47*
551
598
  # @return [String]
552
599
  #
@@ -595,7 +642,12 @@ module Aws::Support
595
642
  # DescribeAttachment operation.
596
643
  #
597
644
  # @!attribute [rw] attachment
598
- # The attachment content and file name.
645
+ # This object includes the attachment content and file name.
646
+ #
647
+ # In the previous response syntax, the value for the `data` parameter
648
+ # appears as `blob`, which is represented as a base64-encoded string.
649
+ # The value for `fileName` is the name of the attachment, such as
650
+ # `troubleshoot-screenshot.png`.
599
651
  # @return [Types::Attachment]
600
652
  #
601
653
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentResponse AWS API Documentation
@@ -1197,7 +1249,7 @@ module Aws::Support
1197
1249
  #
1198
1250
  # @!attribute [rw] description
1199
1251
  # The description of the Trusted Advisor check, which includes the
1200
- # alert criteria and recommended actions (contains HTML markup).
1252
+ # alert criteria and recommended operations (contains HTML markup).
1201
1253
  # @return [String]
1202
1254
  #
1203
1255
  # @!attribute [rw] category
@@ -1347,16 +1399,16 @@ module Aws::Support
1347
1399
  end
1348
1400
 
1349
1401
  # The estimated cost savings that might be realized if the recommended
1350
- # actions are taken.
1402
+ # operations are taken.
1351
1403
  #
1352
1404
  # @!attribute [rw] estimated_monthly_savings
1353
1405
  # The estimated monthly savings that might be realized if the
1354
- # recommended actions are taken.
1406
+ # recommended operations are taken.
1355
1407
  # @return [Float]
1356
1408
  #
1357
1409
  # @!attribute [rw] estimated_percent_monthly_savings
1358
1410
  # The estimated percentage of savings that might be realized if the
1359
- # recommended actions are taken.
1411
+ # recommended operations are taken.
1360
1412
  # @return [Float]
1361
1413
  #
1362
1414
  # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCostOptimizingSummary AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-support
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.22.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-31 00:00:00.000000000 Z
11
+ date: 2020-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AWS Support