aws-sdk-support 1.0.0.rc1 → 1.0.0.rc2
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 +4 -4
- data/lib/aws-sdk-support.rb +2 -2
- data/lib/aws-sdk-support/client.rb +955 -816
- data/lib/aws-sdk-support/client_api.rb +499 -501
- data/lib/aws-sdk-support/errors.rb +4 -13
- data/lib/aws-sdk-support/resource.rb +12 -14
- data/lib/aws-sdk-support/types.rb +1208 -1032
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c316dd5e289787efd10102e35e1433470397ab8b
|
|
4
|
+
data.tar.gz: c57e974509ad0db17320c62eaa9a2fe150ec82cc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3a549ece2f0f7ace12bfb3ae55ab4243439c2025b69e08c9d1b12fb8335aedbfd75c35efa8a90aa26d73090fcd3be048b2bb4dfc3c5a728ce131ad96c13fc4ec
|
|
7
|
+
data.tar.gz: aaebdd4621d8ff2eb8d3e40f90f2e741a61eca57d3b76a4a7a445ef43a316455b94293134fae21bbbd9e7a7f32b83fe5bf062cdf0df7a2022b8f7df3f167316e
|
data/lib/aws-sdk-support.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-support/customizations'
|
|
|
42
42
|
# @service
|
|
43
43
|
module Aws::Support
|
|
44
44
|
|
|
45
|
-
GEM_VERSION = '1.0.0.
|
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
|
46
46
|
|
|
47
47
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -18,853 +18,992 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
22
23
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
23
24
|
|
|
24
25
|
Aws::Plugins::GlobalConfiguration.add_identifier(:support)
|
|
25
26
|
|
|
26
|
-
module Aws
|
|
27
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
27
|
+
module Aws::Support
|
|
28
|
+
class Client < Seahorse::Client::Base
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
include Aws::ClientStubs
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
@identifier = :support
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
set_api(ClientApi::API)
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
51
52
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
55
|
+
# following classes:
|
|
56
|
+
#
|
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
58
|
+
# credentials.
|
|
59
|
+
#
|
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
62
|
+
#
|
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
64
|
+
# shared file, such as `~/.aws/config`.
|
|
65
|
+
#
|
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
67
|
+
#
|
|
68
|
+
# When `:credentials` are not configured directly, the following
|
|
69
|
+
# locations will be searched for credentials:
|
|
70
|
+
#
|
|
71
|
+
# * `Aws.config[:credentials]`
|
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
74
|
+
# * `~/.aws/credentials`
|
|
75
|
+
# * `~/.aws/config`
|
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
77
|
+
# very aggressive. Construct and pass an instance of
|
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
79
|
+
# timeouts.
|
|
80
|
+
#
|
|
81
|
+
# @option options [required, String] :region
|
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
84
|
+
# a default `:region` is search for in the following locations:
|
|
85
|
+
#
|
|
86
|
+
# * `Aws.config[:region]`
|
|
87
|
+
# * `ENV['AWS_REGION']`
|
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
90
|
+
# * `~/.aws/credentials`
|
|
91
|
+
# * `~/.aws/config`
|
|
92
|
+
#
|
|
93
|
+
# @option options [String] :access_key_id
|
|
94
|
+
#
|
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
97
|
+
# the required types.
|
|
98
|
+
#
|
|
99
|
+
# @option options [String] :endpoint
|
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
103
|
+
#
|
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
105
|
+
# The log formatter.
|
|
106
|
+
#
|
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
|
108
|
+
# The log level to send messages to the `:logger` at.
|
|
109
|
+
#
|
|
110
|
+
# @option options [Logger] :logger
|
|
111
|
+
# The Logger instance to send log messages to. If this option
|
|
112
|
+
# is not set, logging will be disabled.
|
|
113
|
+
#
|
|
114
|
+
# @option options [String] :profile ("default")
|
|
115
|
+
# Used when loading credentials from the shared credentials file
|
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
117
|
+
#
|
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
123
|
+
# errors from expired credentials.
|
|
124
|
+
#
|
|
125
|
+
# @option options [String] :secret_access_key
|
|
126
|
+
#
|
|
127
|
+
# @option options [String] :session_token
|
|
128
|
+
#
|
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
|
131
|
+
# Also disable response data type conversions. This option is useful
|
|
132
|
+
# when you want to ensure the highest level of performance by
|
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
|
134
|
+
# structures.
|
|
135
|
+
#
|
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
|
138
|
+
#
|
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
|
140
|
+
# Causes the client to return stubbed responses. By default
|
|
141
|
+
# fake responses are generated and returned. You can specify
|
|
142
|
+
# the response data to return or errors to raise by calling
|
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
144
|
+
#
|
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
146
|
+
# requests are made, and retries are disabled.
|
|
147
|
+
#
|
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
|
149
|
+
# When `true`, request parameters are validated before
|
|
150
|
+
# sending the request.
|
|
151
|
+
#
|
|
152
|
+
def initialize(*args)
|
|
153
|
+
super
|
|
154
|
+
end
|
|
139
155
|
|
|
140
|
-
|
|
156
|
+
# @!group API Operations
|
|
141
157
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
#
|
|
195
|
-
# This operation implements a subset of the features of the AWS Support
|
|
196
|
-
# Center.
|
|
197
|
-
# @option params [String] :case_id
|
|
198
|
-
# The AWS Support case ID requested or returned in the call. The case ID
|
|
199
|
-
# is an alphanumeric string formatted as shown in this example:
|
|
200
|
-
# case-*12345678910-2013-c4c1d2bf33c5cf47*
|
|
201
|
-
# @option params [required, String] :communication_body
|
|
202
|
-
# The body of an email communication to add to the support case.
|
|
203
|
-
# @option params [Array<String>] :cc_email_addresses
|
|
204
|
-
# The email addresses in the CC line of an email to be added to the
|
|
205
|
-
# support case.
|
|
206
|
-
# @option params [String] :attachment_set_id
|
|
207
|
-
# The ID of a set of one or more attachments for the communication to
|
|
208
|
-
# add to the case. Create the set by calling AddAttachmentsToSet
|
|
209
|
-
# @return [Types::AddCommunicationToCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
210
|
-
#
|
|
211
|
-
# * {Types::AddCommunicationToCaseResponse#result #result} => Boolean
|
|
212
|
-
#
|
|
213
|
-
# @example Request syntax with placeholder values
|
|
214
|
-
# resp = client.add_communication_to_case({
|
|
215
|
-
# case_id: "CaseId",
|
|
216
|
-
# communication_body: "CommunicationBody", # required
|
|
217
|
-
# cc_email_addresses: ["CcEmailAddress"],
|
|
218
|
-
# attachment_set_id: "AttachmentSetId",
|
|
219
|
-
# })
|
|
220
|
-
#
|
|
221
|
-
# @example Response structure
|
|
222
|
-
# resp.result #=> Boolean
|
|
223
|
-
# @overload add_communication_to_case(params = {})
|
|
224
|
-
# @param [Hash] params ({})
|
|
225
|
-
def add_communication_to_case(params = {}, options = {})
|
|
226
|
-
req = build_request(:add_communication_to_case, params)
|
|
227
|
-
req.send_request(options)
|
|
228
|
-
end
|
|
158
|
+
# Adds one or more attachments to an attachment set. If an
|
|
159
|
+
# `attachmentSetId` is not specified, a new attachment set is created,
|
|
160
|
+
# and the ID of the set is returned in the response. If an
|
|
161
|
+
# `attachmentSetId` is specified, the attachments are added to the
|
|
162
|
+
# specified set, if it exists.
|
|
163
|
+
#
|
|
164
|
+
# An attachment set is a temporary container for attachments that are to
|
|
165
|
+
# be added to a case or case communication. The set is available for one
|
|
166
|
+
# hour after it is created; the `expiryTime` returned in the response
|
|
167
|
+
# indicates when the set expires. The maximum number of attachments in a
|
|
168
|
+
# set is 3, and the maximum size of any attachment in the set is 5 MB.
|
|
169
|
+
#
|
|
170
|
+
# @option params [String] :attachment_set_id
|
|
171
|
+
# The ID of the attachment set. If an `attachmentSetId` is not
|
|
172
|
+
# specified, a new attachment set is created, and the ID of the set is
|
|
173
|
+
# returned in the response. If an `attachmentSetId` is specified, the
|
|
174
|
+
# attachments are added to the specified set, if it exists.
|
|
175
|
+
#
|
|
176
|
+
# @option params [required, Array<Types::Attachment>] :attachments
|
|
177
|
+
# One or more attachments to add to the set. The limit is 3 attachments
|
|
178
|
+
# per set, and the size limit is 5 MB per attachment.
|
|
179
|
+
#
|
|
180
|
+
# @return [Types::AddAttachmentsToSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
181
|
+
#
|
|
182
|
+
# * {Types::AddAttachmentsToSetResponse#attachment_set_id #attachment_set_id} => String
|
|
183
|
+
# * {Types::AddAttachmentsToSetResponse#expiry_time #expiry_time} => String
|
|
184
|
+
#
|
|
185
|
+
# @example Request syntax with placeholder values
|
|
186
|
+
#
|
|
187
|
+
# resp = client.add_attachments_to_set({
|
|
188
|
+
# attachment_set_id: "AttachmentSetId",
|
|
189
|
+
# attachments: [ # required
|
|
190
|
+
# {
|
|
191
|
+
# file_name: "FileName",
|
|
192
|
+
# data: "data",
|
|
193
|
+
# },
|
|
194
|
+
# ],
|
|
195
|
+
# })
|
|
196
|
+
#
|
|
197
|
+
# @example Response structure
|
|
198
|
+
#
|
|
199
|
+
# resp.attachment_set_id #=> String
|
|
200
|
+
# resp.expiry_time #=> String
|
|
201
|
+
#
|
|
202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSet AWS API Documentation
|
|
203
|
+
#
|
|
204
|
+
# @overload add_attachments_to_set(params = {})
|
|
205
|
+
# @param [Hash] params ({})
|
|
206
|
+
def add_attachments_to_set(params = {}, options = {})
|
|
207
|
+
req = build_request(:add_attachments_to_set, params)
|
|
208
|
+
req.send_request(options)
|
|
209
|
+
end
|
|
229
210
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
# [2]: http://aws.amazon.com/tools/
|
|
283
|
-
# @option params [required, String] :subject
|
|
284
|
-
# The title of the AWS Support case.
|
|
285
|
-
# @option params [String] :service_code
|
|
286
|
-
# The code for the AWS service returned by the call to DescribeServices.
|
|
287
|
-
# @option params [String] :severity_code
|
|
288
|
-
# The code for the severity level returned by the call to
|
|
289
|
-
# DescribeSeverityLevels.
|
|
290
|
-
#
|
|
291
|
-
# <note markdown="1"> The availability of severity levels depends on each customer's
|
|
292
|
-
# support subscription. In other words, your subscription may not
|
|
293
|
-
# necessarily require the urgent level of response time.
|
|
294
|
-
#
|
|
295
|
-
# </note>
|
|
296
|
-
# @option params [String] :category_code
|
|
297
|
-
# The category of problem for the AWS Support case.
|
|
298
|
-
# @option params [required, String] :communication_body
|
|
299
|
-
# The communication body text when you create an AWS Support case by
|
|
300
|
-
# calling CreateCase.
|
|
301
|
-
# @option params [Array<String>] :cc_email_addresses
|
|
302
|
-
# A list of email addresses that AWS Support copies on case
|
|
303
|
-
# correspondence.
|
|
304
|
-
# @option params [String] :language
|
|
305
|
-
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
306
|
-
# Support currently supports English ("en") and Japanese ("ja").
|
|
307
|
-
# Language parameters must be passed explicitly for operations that take
|
|
308
|
-
# them.
|
|
309
|
-
# @option params [String] :issue_type
|
|
310
|
-
# The type of issue for the case. You can specify either
|
|
311
|
-
# "customer-service" or "technical." If you do not indicate a value,
|
|
312
|
-
# the default is "technical."
|
|
313
|
-
# @option params [String] :attachment_set_id
|
|
314
|
-
# The ID of a set of one or more attachments for the case. Create the
|
|
315
|
-
# set by using AddAttachmentsToSet.
|
|
316
|
-
# @return [Types::CreateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
317
|
-
#
|
|
318
|
-
# * {Types::CreateCaseResponse#case_id #caseId} => String
|
|
319
|
-
#
|
|
320
|
-
# @example Request syntax with placeholder values
|
|
321
|
-
# resp = client.create_case({
|
|
322
|
-
# subject: "Subject", # required
|
|
323
|
-
# service_code: "ServiceCode",
|
|
324
|
-
# severity_code: "SeverityCode",
|
|
325
|
-
# category_code: "CategoryCode",
|
|
326
|
-
# communication_body: "CommunicationBody", # required
|
|
327
|
-
# cc_email_addresses: ["CcEmailAddress"],
|
|
328
|
-
# language: "Language",
|
|
329
|
-
# issue_type: "IssueType",
|
|
330
|
-
# attachment_set_id: "AttachmentSetId",
|
|
331
|
-
# })
|
|
332
|
-
#
|
|
333
|
-
# @example Response structure
|
|
334
|
-
# resp.case_id #=> String
|
|
335
|
-
# @overload create_case(params = {})
|
|
336
|
-
# @param [Hash] params ({})
|
|
337
|
-
def create_case(params = {}, options = {})
|
|
338
|
-
req = build_request(:create_case, params)
|
|
339
|
-
req.send_request(options)
|
|
340
|
-
end
|
|
211
|
+
# Adds additional customer communication to an AWS Support case. You use
|
|
212
|
+
# the `caseId` value to identify the case to add communication to. You
|
|
213
|
+
# can list a set of email addresses to copy on the communication using
|
|
214
|
+
# the `ccEmailAddresses` value. The `communicationBody` value contains
|
|
215
|
+
# the text of the communication.
|
|
216
|
+
#
|
|
217
|
+
# The response indicates the success or failure of the request.
|
|
218
|
+
#
|
|
219
|
+
# This operation implements a subset of the features of the AWS Support
|
|
220
|
+
# Center.
|
|
221
|
+
#
|
|
222
|
+
# @option params [String] :case_id
|
|
223
|
+
# The AWS Support case ID requested or returned in the call. The case ID
|
|
224
|
+
# is an alphanumeric string formatted as shown in this example:
|
|
225
|
+
# case-*12345678910-2013-c4c1d2bf33c5cf47*
|
|
226
|
+
#
|
|
227
|
+
# @option params [required, String] :communication_body
|
|
228
|
+
# The body of an email communication to add to the support case.
|
|
229
|
+
#
|
|
230
|
+
# @option params [Array<String>] :cc_email_addresses
|
|
231
|
+
# The email addresses in the CC line of an email to be added to the
|
|
232
|
+
# support case.
|
|
233
|
+
#
|
|
234
|
+
# @option params [String] :attachment_set_id
|
|
235
|
+
# The ID of a set of one or more attachments for the communication to
|
|
236
|
+
# add to the case. Create the set by calling AddAttachmentsToSet
|
|
237
|
+
#
|
|
238
|
+
# @return [Types::AddCommunicationToCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
239
|
+
#
|
|
240
|
+
# * {Types::AddCommunicationToCaseResponse#result #result} => Boolean
|
|
241
|
+
#
|
|
242
|
+
# @example Request syntax with placeholder values
|
|
243
|
+
#
|
|
244
|
+
# resp = client.add_communication_to_case({
|
|
245
|
+
# case_id: "CaseId",
|
|
246
|
+
# communication_body: "CommunicationBody", # required
|
|
247
|
+
# cc_email_addresses: ["CcEmailAddress"],
|
|
248
|
+
# attachment_set_id: "AttachmentSetId",
|
|
249
|
+
# })
|
|
250
|
+
#
|
|
251
|
+
# @example Response structure
|
|
252
|
+
#
|
|
253
|
+
# resp.result #=> Boolean
|
|
254
|
+
#
|
|
255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCase AWS API Documentation
|
|
256
|
+
#
|
|
257
|
+
# @overload add_communication_to_case(params = {})
|
|
258
|
+
# @param [Hash] params ({})
|
|
259
|
+
def add_communication_to_case(params = {}, options = {})
|
|
260
|
+
req = build_request(:add_communication_to_case, params)
|
|
261
|
+
req.send_request(options)
|
|
262
|
+
end
|
|
341
263
|
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
264
|
+
# Creates a new case in the AWS Support Center. This operation is
|
|
265
|
+
# modeled on the behavior of the AWS Support Center [Create Case][1]
|
|
266
|
+
# page. Its parameters require you to specify the following information:
|
|
267
|
+
#
|
|
268
|
+
# * **issueType.** The type of issue for the case. You can specify
|
|
269
|
+
# either "customer-service" or "technical." If you do not indicate
|
|
270
|
+
# a value, the default is "technical."
|
|
271
|
+
#
|
|
272
|
+
# * **serviceCode.** The code for an AWS service. You obtain the
|
|
273
|
+
# `serviceCode` by calling DescribeServices.
|
|
274
|
+
#
|
|
275
|
+
# * **categoryCode.** The category for the service defined for the
|
|
276
|
+
# `serviceCode` value. You also obtain the category code for a service
|
|
277
|
+
# by calling DescribeServices. Each AWS service defines its own set of
|
|
278
|
+
# category codes.
|
|
279
|
+
#
|
|
280
|
+
# * **severityCode.** A value that indicates the urgency of the case,
|
|
281
|
+
# which in turn determines the response time according to your service
|
|
282
|
+
# level agreement with AWS Support. You obtain the SeverityCode by
|
|
283
|
+
# calling DescribeSeverityLevels.
|
|
284
|
+
#
|
|
285
|
+
# * **subject.** The **Subject** field on the AWS Support Center [Create
|
|
286
|
+
# Case][1] page.
|
|
287
|
+
#
|
|
288
|
+
# * **communicationBody.** The **Description** field on the AWS Support
|
|
289
|
+
# Center [Create Case][1] page.
|
|
290
|
+
#
|
|
291
|
+
# * **attachmentSetId.** The ID of a set of attachments that has been
|
|
292
|
+
# created by using AddAttachmentsToSet.
|
|
293
|
+
#
|
|
294
|
+
# * **language.** The human language in which AWS Support handles the
|
|
295
|
+
# case. English and Japanese are currently supported.
|
|
296
|
+
#
|
|
297
|
+
# * **ccEmailAddresses.** The AWS Support Center **CC** field on the
|
|
298
|
+
# [Create Case][1] page. You can list email addresses to be copied on
|
|
299
|
+
# any correspondence about the case. The account that opens the case
|
|
300
|
+
# is already identified by passing the AWS Credentials in the HTTP
|
|
301
|
+
# POST method or in a method or function call from one of the
|
|
302
|
+
# programming languages supported by an [AWS SDK][2].
|
|
303
|
+
#
|
|
304
|
+
# <note markdown="1"> To add additional communication or attachments to an existing case,
|
|
305
|
+
# use AddCommunicationToCase.
|
|
306
|
+
#
|
|
307
|
+
# </note>
|
|
308
|
+
#
|
|
309
|
+
# A successful CreateCase request returns an AWS Support case number.
|
|
310
|
+
# Case numbers are used by the DescribeCases operation to retrieve
|
|
311
|
+
# existing AWS Support cases.
|
|
312
|
+
#
|
|
313
|
+
#
|
|
314
|
+
#
|
|
315
|
+
# [1]: https://console.aws.amazon.com/support/home#/case/create
|
|
316
|
+
# [2]: http://aws.amazon.com/tools/
|
|
317
|
+
#
|
|
318
|
+
# @option params [required, String] :subject
|
|
319
|
+
# The title of the AWS Support case.
|
|
320
|
+
#
|
|
321
|
+
# @option params [String] :service_code
|
|
322
|
+
# The code for the AWS service returned by the call to DescribeServices.
|
|
323
|
+
#
|
|
324
|
+
# @option params [String] :severity_code
|
|
325
|
+
# The code for the severity level returned by the call to
|
|
326
|
+
# DescribeSeverityLevels.
|
|
327
|
+
#
|
|
328
|
+
# <note markdown="1"> The availability of severity levels depends on each customer's
|
|
329
|
+
# support subscription. In other words, your subscription may not
|
|
330
|
+
# necessarily require the urgent level of response time.
|
|
331
|
+
#
|
|
332
|
+
# </note>
|
|
333
|
+
#
|
|
334
|
+
# @option params [String] :category_code
|
|
335
|
+
# The category of problem for the AWS Support case.
|
|
336
|
+
#
|
|
337
|
+
# @option params [required, String] :communication_body
|
|
338
|
+
# The communication body text when you create an AWS Support case by
|
|
339
|
+
# calling CreateCase.
|
|
340
|
+
#
|
|
341
|
+
# @option params [Array<String>] :cc_email_addresses
|
|
342
|
+
# A list of email addresses that AWS Support copies on case
|
|
343
|
+
# correspondence.
|
|
344
|
+
#
|
|
345
|
+
# @option params [String] :language
|
|
346
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
347
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
348
|
+
# Language parameters must be passed explicitly for operations that take
|
|
349
|
+
# them.
|
|
350
|
+
#
|
|
351
|
+
# @option params [String] :issue_type
|
|
352
|
+
# The type of issue for the case. You can specify either
|
|
353
|
+
# "customer-service" or "technical." If you do not indicate a value,
|
|
354
|
+
# the default is "technical."
|
|
355
|
+
#
|
|
356
|
+
# @option params [String] :attachment_set_id
|
|
357
|
+
# The ID of a set of one or more attachments for the case. Create the
|
|
358
|
+
# set by using AddAttachmentsToSet.
|
|
359
|
+
#
|
|
360
|
+
# @return [Types::CreateCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
361
|
+
#
|
|
362
|
+
# * {Types::CreateCaseResponse#case_id #case_id} => String
|
|
363
|
+
#
|
|
364
|
+
# @example Request syntax with placeholder values
|
|
365
|
+
#
|
|
366
|
+
# resp = client.create_case({
|
|
367
|
+
# subject: "Subject", # required
|
|
368
|
+
# service_code: "ServiceCode",
|
|
369
|
+
# severity_code: "SeverityCode",
|
|
370
|
+
# category_code: "CategoryCode",
|
|
371
|
+
# communication_body: "CommunicationBody", # required
|
|
372
|
+
# cc_email_addresses: ["CcEmailAddress"],
|
|
373
|
+
# language: "Language",
|
|
374
|
+
# issue_type: "IssueType",
|
|
375
|
+
# attachment_set_id: "AttachmentSetId",
|
|
376
|
+
# })
|
|
377
|
+
#
|
|
378
|
+
# @example Response structure
|
|
379
|
+
#
|
|
380
|
+
# resp.case_id #=> String
|
|
381
|
+
#
|
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCase AWS API Documentation
|
|
383
|
+
#
|
|
384
|
+
# @overload create_case(params = {})
|
|
385
|
+
# @param [Hash] params ({})
|
|
386
|
+
def create_case(params = {}, options = {})
|
|
387
|
+
req = build_request(:create_case, params)
|
|
388
|
+
req.send_request(options)
|
|
389
|
+
end
|
|
368
390
|
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
# A resumption point for pagination.
|
|
403
|
-
# @option params [Integer] :max_results
|
|
404
|
-
# The maximum number of results to return before paginating.
|
|
405
|
-
# @option params [String] :language
|
|
406
|
-
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
407
|
-
# Support currently supports English ("en") and Japanese ("ja").
|
|
408
|
-
# Language parameters must be passed explicitly for operations that take
|
|
409
|
-
# them.
|
|
410
|
-
# @option params [Boolean] :include_communications
|
|
411
|
-
# Specifies whether communications should be included in the
|
|
412
|
-
# DescribeCases results. The default is *true*.
|
|
413
|
-
# @return [Types::DescribeCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
414
|
-
#
|
|
415
|
-
# * {Types::DescribeCasesResponse#cases #cases} => Array<Types::CaseDetails>
|
|
416
|
-
# * {Types::DescribeCasesResponse#next_token #nextToken} => String
|
|
417
|
-
#
|
|
418
|
-
# @example Request syntax with placeholder values
|
|
419
|
-
# resp = client.describe_cases({
|
|
420
|
-
# case_id_list: ["CaseId"],
|
|
421
|
-
# display_id: "DisplayId",
|
|
422
|
-
# after_time: "AfterTime",
|
|
423
|
-
# before_time: "BeforeTime",
|
|
424
|
-
# include_resolved_cases: false,
|
|
425
|
-
# next_token: "NextToken",
|
|
426
|
-
# max_results: 1,
|
|
427
|
-
# language: "Language",
|
|
428
|
-
# include_communications: false,
|
|
429
|
-
# })
|
|
430
|
-
#
|
|
431
|
-
# @example Response structure
|
|
432
|
-
# resp.cases #=> Array
|
|
433
|
-
# resp.cases[0].case_id #=> String
|
|
434
|
-
# resp.cases[0].display_id #=> String
|
|
435
|
-
# resp.cases[0].subject #=> String
|
|
436
|
-
# resp.cases[0].status #=> String
|
|
437
|
-
# resp.cases[0].service_code #=> String
|
|
438
|
-
# resp.cases[0].category_code #=> String
|
|
439
|
-
# resp.cases[0].severity_code #=> String
|
|
440
|
-
# resp.cases[0].submitted_by #=> String
|
|
441
|
-
# resp.cases[0].time_created #=> String
|
|
442
|
-
# resp.cases[0].recent_communications.communications #=> Array
|
|
443
|
-
# resp.cases[0].recent_communications.communications[0].case_id #=> String
|
|
444
|
-
# resp.cases[0].recent_communications.communications[0].body #=> String
|
|
445
|
-
# resp.cases[0].recent_communications.communications[0].submitted_by #=> String
|
|
446
|
-
# resp.cases[0].recent_communications.communications[0].time_created #=> String
|
|
447
|
-
# resp.cases[0].recent_communications.communications[0].attachment_set #=> Array
|
|
448
|
-
# resp.cases[0].recent_communications.communications[0].attachment_set[0].attachment_id #=> String
|
|
449
|
-
# resp.cases[0].recent_communications.communications[0].attachment_set[0].file_name #=> String
|
|
450
|
-
# resp.cases[0].recent_communications.next_token #=> String
|
|
451
|
-
# resp.cases[0].cc_email_addresses #=> Array
|
|
452
|
-
# resp.cases[0].cc_email_addresses[0] #=> String
|
|
453
|
-
# resp.cases[0].language #=> String
|
|
454
|
-
# resp.next_token #=> String
|
|
455
|
-
# @overload describe_cases(params = {})
|
|
456
|
-
# @param [Hash] params ({})
|
|
457
|
-
def describe_cases(params = {}, options = {})
|
|
458
|
-
req = build_request(:describe_cases, params)
|
|
459
|
-
req.send_request(options)
|
|
460
|
-
end
|
|
391
|
+
# Returns the attachment that has the specified ID. Attachment IDs are
|
|
392
|
+
# generated by the case management system when you add an attachment to
|
|
393
|
+
# a case or case communication. Attachment IDs are returned in the
|
|
394
|
+
# AttachmentDetails objects that are returned by the
|
|
395
|
+
# DescribeCommunications operation.
|
|
396
|
+
#
|
|
397
|
+
# @option params [required, String] :attachment_id
|
|
398
|
+
# The ID of the attachment to return. Attachment IDs are returned by the
|
|
399
|
+
# DescribeCommunications operation.
|
|
400
|
+
#
|
|
401
|
+
# @return [Types::DescribeAttachmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
402
|
+
#
|
|
403
|
+
# * {Types::DescribeAttachmentResponse#attachment #attachment} => Types::Attachment
|
|
404
|
+
#
|
|
405
|
+
# @example Request syntax with placeholder values
|
|
406
|
+
#
|
|
407
|
+
# resp = client.describe_attachment({
|
|
408
|
+
# attachment_id: "AttachmentId", # required
|
|
409
|
+
# })
|
|
410
|
+
#
|
|
411
|
+
# @example Response structure
|
|
412
|
+
#
|
|
413
|
+
# resp.attachment.file_name #=> String
|
|
414
|
+
# resp.attachment.data #=> String
|
|
415
|
+
#
|
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachment AWS API Documentation
|
|
417
|
+
#
|
|
418
|
+
# @overload describe_attachment(params = {})
|
|
419
|
+
# @param [Hash] params ({})
|
|
420
|
+
def describe_attachment(params = {}, options = {})
|
|
421
|
+
req = build_request(:describe_attachment, params)
|
|
422
|
+
req.send_request(options)
|
|
423
|
+
end
|
|
461
424
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
425
|
+
# Returns a list of cases that you specify by passing one or more case
|
|
426
|
+
# IDs. In addition, you can filter the cases by date by setting values
|
|
427
|
+
# for the `afterTime` and `beforeTime` request parameters. You can set
|
|
428
|
+
# values for the `includeResolvedCases` and `includeCommunications`
|
|
429
|
+
# request parameters to control how much information is returned.
|
|
430
|
+
#
|
|
431
|
+
# Case data is available for 12 months after creation. If a case was
|
|
432
|
+
# created more than 12 months ago, a request for data might cause an
|
|
433
|
+
# error.
|
|
434
|
+
#
|
|
435
|
+
# The response returns the following in JSON format:
|
|
436
|
+
#
|
|
437
|
+
# * One or more CaseDetails data types.
|
|
438
|
+
#
|
|
439
|
+
# * One or more `nextToken` values, which specify where to paginate the
|
|
440
|
+
# returned records represented by the `CaseDetails` objects.
|
|
441
|
+
#
|
|
442
|
+
# @option params [Array<String>] :case_id_list
|
|
443
|
+
# A list of ID numbers of the support cases you want returned. The
|
|
444
|
+
# maximum number of cases is 100.
|
|
445
|
+
#
|
|
446
|
+
# @option params [String] :display_id
|
|
447
|
+
# The ID displayed for a case in the AWS Support Center user interface.
|
|
448
|
+
#
|
|
449
|
+
# @option params [String] :after_time
|
|
450
|
+
# The start date for a filtered date search on support case
|
|
451
|
+
# communications. Case communications are available for 12 months after
|
|
452
|
+
# creation.
|
|
453
|
+
#
|
|
454
|
+
# @option params [String] :before_time
|
|
455
|
+
# The end date for a filtered date search on support case
|
|
456
|
+
# communications. Case communications are available for 12 months after
|
|
457
|
+
# creation.
|
|
458
|
+
#
|
|
459
|
+
# @option params [Boolean] :include_resolved_cases
|
|
460
|
+
# Specifies whether resolved support cases should be included in the
|
|
461
|
+
# DescribeCases results. The default is *false*.
|
|
462
|
+
#
|
|
463
|
+
# @option params [String] :next_token
|
|
464
|
+
# A resumption point for pagination.
|
|
465
|
+
#
|
|
466
|
+
# @option params [Integer] :max_results
|
|
467
|
+
# The maximum number of results to return before paginating.
|
|
468
|
+
#
|
|
469
|
+
# @option params [String] :language
|
|
470
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
471
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
472
|
+
# Language parameters must be passed explicitly for operations that take
|
|
473
|
+
# them.
|
|
474
|
+
#
|
|
475
|
+
# @option params [Boolean] :include_communications
|
|
476
|
+
# Specifies whether communications should be included in the
|
|
477
|
+
# DescribeCases results. The default is *true*.
|
|
478
|
+
#
|
|
479
|
+
# @return [Types::DescribeCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
480
|
+
#
|
|
481
|
+
# * {Types::DescribeCasesResponse#cases #cases} => Array<Types::CaseDetails>
|
|
482
|
+
# * {Types::DescribeCasesResponse#next_token #next_token} => String
|
|
483
|
+
#
|
|
484
|
+
# @example Request syntax with placeholder values
|
|
485
|
+
#
|
|
486
|
+
# resp = client.describe_cases({
|
|
487
|
+
# case_id_list: ["CaseId"],
|
|
488
|
+
# display_id: "DisplayId",
|
|
489
|
+
# after_time: "AfterTime",
|
|
490
|
+
# before_time: "BeforeTime",
|
|
491
|
+
# include_resolved_cases: false,
|
|
492
|
+
# next_token: "NextToken",
|
|
493
|
+
# max_results: 1,
|
|
494
|
+
# language: "Language",
|
|
495
|
+
# include_communications: false,
|
|
496
|
+
# })
|
|
497
|
+
#
|
|
498
|
+
# @example Response structure
|
|
499
|
+
#
|
|
500
|
+
# resp.cases #=> Array
|
|
501
|
+
# resp.cases[0].case_id #=> String
|
|
502
|
+
# resp.cases[0].display_id #=> String
|
|
503
|
+
# resp.cases[0].subject #=> String
|
|
504
|
+
# resp.cases[0].status #=> String
|
|
505
|
+
# resp.cases[0].service_code #=> String
|
|
506
|
+
# resp.cases[0].category_code #=> String
|
|
507
|
+
# resp.cases[0].severity_code #=> String
|
|
508
|
+
# resp.cases[0].submitted_by #=> String
|
|
509
|
+
# resp.cases[0].time_created #=> String
|
|
510
|
+
# resp.cases[0].recent_communications.communications #=> Array
|
|
511
|
+
# resp.cases[0].recent_communications.communications[0].case_id #=> String
|
|
512
|
+
# resp.cases[0].recent_communications.communications[0].body #=> String
|
|
513
|
+
# resp.cases[0].recent_communications.communications[0].submitted_by #=> String
|
|
514
|
+
# resp.cases[0].recent_communications.communications[0].time_created #=> String
|
|
515
|
+
# resp.cases[0].recent_communications.communications[0].attachment_set #=> Array
|
|
516
|
+
# resp.cases[0].recent_communications.communications[0].attachment_set[0].attachment_id #=> String
|
|
517
|
+
# resp.cases[0].recent_communications.communications[0].attachment_set[0].file_name #=> String
|
|
518
|
+
# resp.cases[0].recent_communications.next_token #=> String
|
|
519
|
+
# resp.cases[0].cc_email_addresses #=> Array
|
|
520
|
+
# resp.cases[0].cc_email_addresses[0] #=> String
|
|
521
|
+
# resp.cases[0].language #=> String
|
|
522
|
+
# resp.next_token #=> String
|
|
523
|
+
#
|
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCases AWS API Documentation
|
|
525
|
+
#
|
|
526
|
+
# @overload describe_cases(params = {})
|
|
527
|
+
# @param [Hash] params ({})
|
|
528
|
+
def describe_cases(params = {}, options = {})
|
|
529
|
+
req = build_request(:describe_cases, params)
|
|
530
|
+
req.send_request(options)
|
|
531
|
+
end
|
|
521
532
|
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
533
|
+
# Returns communications (and attachments) for one or more support
|
|
534
|
+
# cases. You can use the `afterTime` and `beforeTime` parameters to
|
|
535
|
+
# filter by date. You can use the `caseId` parameter to restrict the
|
|
536
|
+
# results to a particular case.
|
|
537
|
+
#
|
|
538
|
+
# Case data is available for 12 months after creation. If a case was
|
|
539
|
+
# created more than 12 months ago, a request for data might cause an
|
|
540
|
+
# error.
|
|
541
|
+
#
|
|
542
|
+
# You can use the `maxResults` and `nextToken` parameters to control the
|
|
543
|
+
# pagination of the result set. Set `maxResults` to the number of cases
|
|
544
|
+
# you want displayed on each page, and use `nextToken` to specify the
|
|
545
|
+
# resumption of pagination.
|
|
546
|
+
#
|
|
547
|
+
# @option params [required, String] :case_id
|
|
548
|
+
# The AWS Support case ID requested or returned in the call. The case ID
|
|
549
|
+
# is an alphanumeric string formatted as shown in this example:
|
|
550
|
+
# case-*12345678910-2013-c4c1d2bf33c5cf47*
|
|
551
|
+
#
|
|
552
|
+
# @option params [String] :before_time
|
|
553
|
+
# The end date for a filtered date search on support case
|
|
554
|
+
# communications. Case communications are available for 12 months after
|
|
555
|
+
# creation.
|
|
556
|
+
#
|
|
557
|
+
# @option params [String] :after_time
|
|
558
|
+
# The start date for a filtered date search on support case
|
|
559
|
+
# communications. Case communications are available for 12 months after
|
|
560
|
+
# creation.
|
|
561
|
+
#
|
|
562
|
+
# @option params [String] :next_token
|
|
563
|
+
# A resumption point for pagination.
|
|
564
|
+
#
|
|
565
|
+
# @option params [Integer] :max_results
|
|
566
|
+
# The maximum number of results to return before paginating.
|
|
567
|
+
#
|
|
568
|
+
# @return [Types::DescribeCommunicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
569
|
+
#
|
|
570
|
+
# * {Types::DescribeCommunicationsResponse#communications #communications} => Array<Types::Communication>
|
|
571
|
+
# * {Types::DescribeCommunicationsResponse#next_token #next_token} => String
|
|
572
|
+
#
|
|
573
|
+
# @example Request syntax with placeholder values
|
|
574
|
+
#
|
|
575
|
+
# resp = client.describe_communications({
|
|
576
|
+
# case_id: "CaseId", # required
|
|
577
|
+
# before_time: "BeforeTime",
|
|
578
|
+
# after_time: "AfterTime",
|
|
579
|
+
# next_token: "NextToken",
|
|
580
|
+
# max_results: 1,
|
|
581
|
+
# })
|
|
582
|
+
#
|
|
583
|
+
# @example Response structure
|
|
584
|
+
#
|
|
585
|
+
# resp.communications #=> Array
|
|
586
|
+
# resp.communications[0].case_id #=> String
|
|
587
|
+
# resp.communications[0].body #=> String
|
|
588
|
+
# resp.communications[0].submitted_by #=> String
|
|
589
|
+
# resp.communications[0].time_created #=> String
|
|
590
|
+
# resp.communications[0].attachment_set #=> Array
|
|
591
|
+
# resp.communications[0].attachment_set[0].attachment_id #=> String
|
|
592
|
+
# resp.communications[0].attachment_set[0].file_name #=> String
|
|
593
|
+
# resp.next_token #=> String
|
|
594
|
+
#
|
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunications AWS API Documentation
|
|
596
|
+
#
|
|
597
|
+
# @overload describe_communications(params = {})
|
|
598
|
+
# @param [Hash] params ({})
|
|
599
|
+
def describe_communications(params = {}, options = {})
|
|
600
|
+
req = build_request(:describe_communications, params)
|
|
601
|
+
req.send_request(options)
|
|
602
|
+
end
|
|
569
603
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
604
|
+
# Returns the current list of AWS services and a list of service
|
|
605
|
+
# categories that applies to each one. You then use service names and
|
|
606
|
+
# categories in your CreateCase requests. Each AWS service has its own
|
|
607
|
+
# set of categories.
|
|
608
|
+
#
|
|
609
|
+
# The service codes and category codes correspond to the values that are
|
|
610
|
+
# displayed in the **Service** and **Category** drop-down lists on the
|
|
611
|
+
# AWS Support Center [Create Case][1] page. The values in those fields,
|
|
612
|
+
# however, do not necessarily match the service codes and categories
|
|
613
|
+
# returned by the `DescribeServices` request. Always use the service
|
|
614
|
+
# codes and categories obtained programmatically. This practice ensures
|
|
615
|
+
# that you always have the most recent set of service and category
|
|
616
|
+
# codes.
|
|
617
|
+
#
|
|
618
|
+
#
|
|
619
|
+
#
|
|
620
|
+
# [1]: https://console.aws.amazon.com/support/home#/case/create
|
|
621
|
+
#
|
|
622
|
+
# @option params [Array<String>] :service_code_list
|
|
623
|
+
# A JSON-formatted list of service codes available for AWS services.
|
|
624
|
+
#
|
|
625
|
+
# @option params [String] :language
|
|
626
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
627
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
628
|
+
# Language parameters must be passed explicitly for operations that take
|
|
629
|
+
# them.
|
|
630
|
+
#
|
|
631
|
+
# @return [Types::DescribeServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
632
|
+
#
|
|
633
|
+
# * {Types::DescribeServicesResponse#services #services} => Array<Types::Service>
|
|
634
|
+
#
|
|
635
|
+
# @example Request syntax with placeholder values
|
|
636
|
+
#
|
|
637
|
+
# resp = client.describe_services({
|
|
638
|
+
# service_code_list: ["ServiceCode"],
|
|
639
|
+
# language: "Language",
|
|
640
|
+
# })
|
|
641
|
+
#
|
|
642
|
+
# @example Response structure
|
|
643
|
+
#
|
|
644
|
+
# resp.services #=> Array
|
|
645
|
+
# resp.services[0].code #=> String
|
|
646
|
+
# resp.services[0].name #=> String
|
|
647
|
+
# resp.services[0].categories #=> Array
|
|
648
|
+
# resp.services[0].categories[0].code #=> String
|
|
649
|
+
# resp.services[0].categories[0].name #=> String
|
|
650
|
+
#
|
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServices AWS API Documentation
|
|
652
|
+
#
|
|
653
|
+
# @overload describe_services(params = {})
|
|
654
|
+
# @param [Hash] params ({})
|
|
655
|
+
def describe_services(params = {}, options = {})
|
|
656
|
+
req = build_request(:describe_services, params)
|
|
657
|
+
req.send_request(options)
|
|
658
|
+
end
|
|
597
659
|
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
660
|
+
# Returns the list of severity levels that you can assign to an AWS
|
|
661
|
+
# Support case. The severity level for a case is also a field in the
|
|
662
|
+
# CaseDetails data type included in any CreateCase request.
|
|
663
|
+
#
|
|
664
|
+
# @option params [String] :language
|
|
665
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
666
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
667
|
+
# Language parameters must be passed explicitly for operations that take
|
|
668
|
+
# them.
|
|
669
|
+
#
|
|
670
|
+
# @return [Types::DescribeSeverityLevelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
671
|
+
#
|
|
672
|
+
# * {Types::DescribeSeverityLevelsResponse#severity_levels #severity_levels} => Array<Types::SeverityLevel>
|
|
673
|
+
#
|
|
674
|
+
# @example Request syntax with placeholder values
|
|
675
|
+
#
|
|
676
|
+
# resp = client.describe_severity_levels({
|
|
677
|
+
# language: "Language",
|
|
678
|
+
# })
|
|
679
|
+
#
|
|
680
|
+
# @example Response structure
|
|
681
|
+
#
|
|
682
|
+
# resp.severity_levels #=> Array
|
|
683
|
+
# resp.severity_levels[0].code #=> String
|
|
684
|
+
# resp.severity_levels[0].name #=> String
|
|
685
|
+
#
|
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevels AWS API Documentation
|
|
687
|
+
#
|
|
688
|
+
# @overload describe_severity_levels(params = {})
|
|
689
|
+
# @param [Hash] params ({})
|
|
690
|
+
def describe_severity_levels(params = {}, options = {})
|
|
691
|
+
req = build_request(:describe_severity_levels, params)
|
|
692
|
+
req.send_request(options)
|
|
693
|
+
end
|
|
632
694
|
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
# resp.result.status #=> String
|
|
675
|
-
# resp.result.resources_summary.resources_processed #=> Integer
|
|
676
|
-
# resp.result.resources_summary.resources_flagged #=> Integer
|
|
677
|
-
# resp.result.resources_summary.resources_ignored #=> Integer
|
|
678
|
-
# resp.result.resources_summary.resources_suppressed #=> Integer
|
|
679
|
-
# resp.result.category_specific_summary.cost_optimizing.estimated_monthly_savings #=> Float
|
|
680
|
-
# resp.result.category_specific_summary.cost_optimizing.estimated_percent_monthly_savings #=> Float
|
|
681
|
-
# resp.result.flagged_resources #=> Array
|
|
682
|
-
# resp.result.flagged_resources[0].status #=> String
|
|
683
|
-
# resp.result.flagged_resources[0].region #=> String
|
|
684
|
-
# resp.result.flagged_resources[0].resource_id #=> String
|
|
685
|
-
# resp.result.flagged_resources[0].is_suppressed #=> Boolean
|
|
686
|
-
# resp.result.flagged_resources[0].metadata #=> Array
|
|
687
|
-
# resp.result.flagged_resources[0].metadata[0] #=> String
|
|
688
|
-
# @overload describe_trusted_advisor_check_result(params = {})
|
|
689
|
-
# @param [Hash] params ({})
|
|
690
|
-
def describe_trusted_advisor_check_result(params = {}, options = {})
|
|
691
|
-
req = build_request(:describe_trusted_advisor_check_result, params)
|
|
692
|
-
req.send_request(options)
|
|
693
|
-
end
|
|
695
|
+
# Returns the refresh status of the Trusted Advisor checks that have the
|
|
696
|
+
# specified check IDs. Check IDs can be obtained by calling
|
|
697
|
+
# DescribeTrustedAdvisorChecks.
|
|
698
|
+
#
|
|
699
|
+
# <note markdown="1"> Some checks are refreshed automatically, and their refresh statuses
|
|
700
|
+
# cannot be retrieved by using this operation. Use of the
|
|
701
|
+
# `DescribeTrustedAdvisorCheckRefreshStatuses` operation for these
|
|
702
|
+
# checks causes an `InvalidParameterValue` error.
|
|
703
|
+
#
|
|
704
|
+
# </note>
|
|
705
|
+
#
|
|
706
|
+
# @option params [required, Array<String>] :check_ids
|
|
707
|
+
# The IDs of the Trusted Advisor checks to get the status of. **Note:**
|
|
708
|
+
# Specifying the check ID of a check that is automatically refreshed
|
|
709
|
+
# causes an `InvalidParameterValue` error.
|
|
710
|
+
#
|
|
711
|
+
# @return [Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
712
|
+
#
|
|
713
|
+
# * {Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse#statuses #statuses} => Array<Types::TrustedAdvisorCheckRefreshStatus>
|
|
714
|
+
#
|
|
715
|
+
# @example Request syntax with placeholder values
|
|
716
|
+
#
|
|
717
|
+
# resp = client.describe_trusted_advisor_check_refresh_statuses({
|
|
718
|
+
# check_ids: ["String"], # required
|
|
719
|
+
# })
|
|
720
|
+
#
|
|
721
|
+
# @example Response structure
|
|
722
|
+
#
|
|
723
|
+
# resp.statuses #=> Array
|
|
724
|
+
# resp.statuses[0].check_id #=> String
|
|
725
|
+
# resp.statuses[0].status #=> String
|
|
726
|
+
# resp.statuses[0].millis_until_next_refreshable #=> Integer
|
|
727
|
+
#
|
|
728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses AWS API Documentation
|
|
729
|
+
#
|
|
730
|
+
# @overload describe_trusted_advisor_check_refresh_statuses(params = {})
|
|
731
|
+
# @param [Hash] params ({})
|
|
732
|
+
def describe_trusted_advisor_check_refresh_statuses(params = {}, options = {})
|
|
733
|
+
req = build_request(:describe_trusted_advisor_check_refresh_statuses, params)
|
|
734
|
+
req.send_request(options)
|
|
735
|
+
end
|
|
694
736
|
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
737
|
+
# Returns the results of the Trusted Advisor check that has the
|
|
738
|
+
# specified check ID. Check IDs can be obtained by calling
|
|
739
|
+
# DescribeTrustedAdvisorChecks.
|
|
740
|
+
#
|
|
741
|
+
# The response contains a TrustedAdvisorCheckResult object, which
|
|
742
|
+
# contains these three objects:
|
|
743
|
+
#
|
|
744
|
+
# * TrustedAdvisorCategorySpecificSummary
|
|
745
|
+
#
|
|
746
|
+
# * TrustedAdvisorResourceDetail
|
|
747
|
+
#
|
|
748
|
+
# * TrustedAdvisorResourcesSummary
|
|
749
|
+
#
|
|
750
|
+
# In addition, the response contains these fields:
|
|
751
|
+
#
|
|
752
|
+
# * **status.** The alert status of the check: "ok" (green),
|
|
753
|
+
# "warning" (yellow), "error" (red), or "not\_available".
|
|
754
|
+
#
|
|
755
|
+
# * **timestamp.** The time of the last refresh of the check.
|
|
756
|
+
#
|
|
757
|
+
# * **checkId.** The unique identifier for the check.
|
|
758
|
+
#
|
|
759
|
+
# @option params [required, String] :check_id
|
|
760
|
+
# The unique identifier for the Trusted Advisor check.
|
|
761
|
+
#
|
|
762
|
+
# @option params [String] :language
|
|
763
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
764
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
765
|
+
# Language parameters must be passed explicitly for operations that take
|
|
766
|
+
# them.
|
|
767
|
+
#
|
|
768
|
+
# @return [Types::DescribeTrustedAdvisorCheckResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
769
|
+
#
|
|
770
|
+
# * {Types::DescribeTrustedAdvisorCheckResultResponse#result #result} => Types::TrustedAdvisorCheckResult
|
|
771
|
+
#
|
|
772
|
+
# @example Request syntax with placeholder values
|
|
773
|
+
#
|
|
774
|
+
# resp = client.describe_trusted_advisor_check_result({
|
|
775
|
+
# check_id: "String", # required
|
|
776
|
+
# language: "String",
|
|
777
|
+
# })
|
|
778
|
+
#
|
|
779
|
+
# @example Response structure
|
|
780
|
+
#
|
|
781
|
+
# resp.result.check_id #=> String
|
|
782
|
+
# resp.result.timestamp #=> String
|
|
783
|
+
# resp.result.status #=> String
|
|
784
|
+
# resp.result.resources_summary.resources_processed #=> Integer
|
|
785
|
+
# resp.result.resources_summary.resources_flagged #=> Integer
|
|
786
|
+
# resp.result.resources_summary.resources_ignored #=> Integer
|
|
787
|
+
# resp.result.resources_summary.resources_suppressed #=> Integer
|
|
788
|
+
# resp.result.category_specific_summary.cost_optimizing.estimated_monthly_savings #=> Float
|
|
789
|
+
# resp.result.category_specific_summary.cost_optimizing.estimated_percent_monthly_savings #=> Float
|
|
790
|
+
# resp.result.flagged_resources #=> Array
|
|
791
|
+
# resp.result.flagged_resources[0].status #=> String
|
|
792
|
+
# resp.result.flagged_resources[0].region #=> String
|
|
793
|
+
# resp.result.flagged_resources[0].resource_id #=> String
|
|
794
|
+
# resp.result.flagged_resources[0].is_suppressed #=> Boolean
|
|
795
|
+
# resp.result.flagged_resources[0].metadata #=> Array
|
|
796
|
+
# resp.result.flagged_resources[0].metadata[0] #=> String
|
|
797
|
+
#
|
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResult AWS API Documentation
|
|
799
|
+
#
|
|
800
|
+
# @overload describe_trusted_advisor_check_result(params = {})
|
|
801
|
+
# @param [Hash] params ({})
|
|
802
|
+
def describe_trusted_advisor_check_result(params = {}, options = {})
|
|
803
|
+
req = build_request(:describe_trusted_advisor_check_result, params)
|
|
804
|
+
req.send_request(options)
|
|
805
|
+
end
|
|
729
806
|
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
807
|
+
# Returns the summaries of the results of the Trusted Advisor checks
|
|
808
|
+
# that have the specified check IDs. Check IDs can be obtained by
|
|
809
|
+
# calling DescribeTrustedAdvisorChecks.
|
|
810
|
+
#
|
|
811
|
+
# The response contains an array of TrustedAdvisorCheckSummary objects.
|
|
812
|
+
#
|
|
813
|
+
# @option params [required, Array<String>] :check_ids
|
|
814
|
+
# The IDs of the Trusted Advisor checks.
|
|
815
|
+
#
|
|
816
|
+
# @return [Types::DescribeTrustedAdvisorCheckSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
817
|
+
#
|
|
818
|
+
# * {Types::DescribeTrustedAdvisorCheckSummariesResponse#summaries #summaries} => Array<Types::TrustedAdvisorCheckSummary>
|
|
819
|
+
#
|
|
820
|
+
# @example Request syntax with placeholder values
|
|
821
|
+
#
|
|
822
|
+
# resp = client.describe_trusted_advisor_check_summaries({
|
|
823
|
+
# check_ids: ["String"], # required
|
|
824
|
+
# })
|
|
825
|
+
#
|
|
826
|
+
# @example Response structure
|
|
827
|
+
#
|
|
828
|
+
# resp.summaries #=> Array
|
|
829
|
+
# resp.summaries[0].check_id #=> String
|
|
830
|
+
# resp.summaries[0].timestamp #=> String
|
|
831
|
+
# resp.summaries[0].status #=> String
|
|
832
|
+
# resp.summaries[0].has_flagged_resources #=> Boolean
|
|
833
|
+
# resp.summaries[0].resources_summary.resources_processed #=> Integer
|
|
834
|
+
# resp.summaries[0].resources_summary.resources_flagged #=> Integer
|
|
835
|
+
# resp.summaries[0].resources_summary.resources_ignored #=> Integer
|
|
836
|
+
# resp.summaries[0].resources_summary.resources_suppressed #=> Integer
|
|
837
|
+
# resp.summaries[0].category_specific_summary.cost_optimizing.estimated_monthly_savings #=> Float
|
|
838
|
+
# resp.summaries[0].category_specific_summary.cost_optimizing.estimated_percent_monthly_savings #=> Float
|
|
839
|
+
#
|
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries AWS API Documentation
|
|
841
|
+
#
|
|
842
|
+
# @overload describe_trusted_advisor_check_summaries(params = {})
|
|
843
|
+
# @param [Hash] params ({})
|
|
844
|
+
def describe_trusted_advisor_check_summaries(params = {}, options = {})
|
|
845
|
+
req = build_request(:describe_trusted_advisor_check_summaries, params)
|
|
846
|
+
req.send_request(options)
|
|
847
|
+
end
|
|
763
848
|
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
req = build_request(:refresh_trusted_advisor_check, params)
|
|
805
|
-
req.send_request(options)
|
|
806
|
-
end
|
|
849
|
+
# Returns information about all available Trusted Advisor checks,
|
|
850
|
+
# including name, ID, category, description, and metadata. You must
|
|
851
|
+
# specify a language code; English ("en") and Japanese ("ja") are
|
|
852
|
+
# currently supported. The response contains a
|
|
853
|
+
# TrustedAdvisorCheckDescription for each check.
|
|
854
|
+
#
|
|
855
|
+
# @option params [required, String] :language
|
|
856
|
+
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
|
857
|
+
# Support currently supports English ("en") and Japanese ("ja").
|
|
858
|
+
# Language parameters must be passed explicitly for operations that take
|
|
859
|
+
# them.
|
|
860
|
+
#
|
|
861
|
+
# @return [Types::DescribeTrustedAdvisorChecksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
862
|
+
#
|
|
863
|
+
# * {Types::DescribeTrustedAdvisorChecksResponse#checks #checks} => Array<Types::TrustedAdvisorCheckDescription>
|
|
864
|
+
#
|
|
865
|
+
# @example Request syntax with placeholder values
|
|
866
|
+
#
|
|
867
|
+
# resp = client.describe_trusted_advisor_checks({
|
|
868
|
+
# language: "String", # required
|
|
869
|
+
# })
|
|
870
|
+
#
|
|
871
|
+
# @example Response structure
|
|
872
|
+
#
|
|
873
|
+
# resp.checks #=> Array
|
|
874
|
+
# resp.checks[0].id #=> String
|
|
875
|
+
# resp.checks[0].name #=> String
|
|
876
|
+
# resp.checks[0].description #=> String
|
|
877
|
+
# resp.checks[0].category #=> String
|
|
878
|
+
# resp.checks[0].metadata #=> Array
|
|
879
|
+
# resp.checks[0].metadata[0] #=> String
|
|
880
|
+
#
|
|
881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecks AWS API Documentation
|
|
882
|
+
#
|
|
883
|
+
# @overload describe_trusted_advisor_checks(params = {})
|
|
884
|
+
# @param [Hash] params ({})
|
|
885
|
+
def describe_trusted_advisor_checks(params = {}, options = {})
|
|
886
|
+
req = build_request(:describe_trusted_advisor_checks, params)
|
|
887
|
+
req.send_request(options)
|
|
888
|
+
end
|
|
807
889
|
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
890
|
+
# Requests a refresh of the Trusted Advisor check that has the specified
|
|
891
|
+
# check ID. Check IDs can be obtained by calling
|
|
892
|
+
# DescribeTrustedAdvisorChecks.
|
|
893
|
+
#
|
|
894
|
+
# <note markdown="1"> Some checks are refreshed automatically, and they cannot be refreshed
|
|
895
|
+
# by using this operation. Use of the `RefreshTrustedAdvisorCheck`
|
|
896
|
+
# operation for these checks causes an `InvalidParameterValue` error.
|
|
897
|
+
#
|
|
898
|
+
# </note>
|
|
899
|
+
#
|
|
900
|
+
# The response contains a TrustedAdvisorCheckRefreshStatus object, which
|
|
901
|
+
# contains these fields:
|
|
902
|
+
#
|
|
903
|
+
# * **status.** The refresh status of the check: "none", "enqueued",
|
|
904
|
+
# "processing", "success", or "abandoned".
|
|
905
|
+
#
|
|
906
|
+
# * **millisUntilNextRefreshable.** The amount of time, in milliseconds,
|
|
907
|
+
# until the check is eligible for refresh.
|
|
908
|
+
#
|
|
909
|
+
# * **checkId.** The unique identifier for the check.
|
|
910
|
+
#
|
|
911
|
+
# @option params [required, String] :check_id
|
|
912
|
+
# The unique identifier for the Trusted Advisor check to refresh.
|
|
913
|
+
# **Note:** Specifying the check ID of a check that is automatically
|
|
914
|
+
# refreshed causes an `InvalidParameterValue` error.
|
|
915
|
+
#
|
|
916
|
+
# @return [Types::RefreshTrustedAdvisorCheckResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
917
|
+
#
|
|
918
|
+
# * {Types::RefreshTrustedAdvisorCheckResponse#status #status} => Types::TrustedAdvisorCheckRefreshStatus
|
|
919
|
+
#
|
|
920
|
+
# @example Request syntax with placeholder values
|
|
921
|
+
#
|
|
922
|
+
# resp = client.refresh_trusted_advisor_check({
|
|
923
|
+
# check_id: "String", # required
|
|
924
|
+
# })
|
|
925
|
+
#
|
|
926
|
+
# @example Response structure
|
|
927
|
+
#
|
|
928
|
+
# resp.status.check_id #=> String
|
|
929
|
+
# resp.status.status #=> String
|
|
930
|
+
# resp.status.millis_until_next_refreshable #=> Integer
|
|
931
|
+
#
|
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheck AWS API Documentation
|
|
933
|
+
#
|
|
934
|
+
# @overload refresh_trusted_advisor_check(params = {})
|
|
935
|
+
# @param [Hash] params ({})
|
|
936
|
+
def refresh_trusted_advisor_check(params = {}, options = {})
|
|
937
|
+
req = build_request(:refresh_trusted_advisor_check, params)
|
|
938
|
+
req.send_request(options)
|
|
939
|
+
end
|
|
833
940
|
|
|
834
|
-
|
|
941
|
+
# Takes a `caseId` and returns the initial state of the case along with
|
|
942
|
+
# the state of the case after the call to ResolveCase completed.
|
|
943
|
+
#
|
|
944
|
+
# @option params [String] :case_id
|
|
945
|
+
# The AWS Support case ID requested or returned in the call. The case ID
|
|
946
|
+
# is an alphanumeric string formatted as shown in this example:
|
|
947
|
+
# case-*12345678910-2013-c4c1d2bf33c5cf47*
|
|
948
|
+
#
|
|
949
|
+
# @return [Types::ResolveCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
950
|
+
#
|
|
951
|
+
# * {Types::ResolveCaseResponse#initial_case_status #initial_case_status} => String
|
|
952
|
+
# * {Types::ResolveCaseResponse#final_case_status #final_case_status} => String
|
|
953
|
+
#
|
|
954
|
+
# @example Request syntax with placeholder values
|
|
955
|
+
#
|
|
956
|
+
# resp = client.resolve_case({
|
|
957
|
+
# case_id: "CaseId",
|
|
958
|
+
# })
|
|
959
|
+
#
|
|
960
|
+
# @example Response structure
|
|
961
|
+
#
|
|
962
|
+
# resp.initial_case_status #=> String
|
|
963
|
+
# resp.final_case_status #=> String
|
|
964
|
+
#
|
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCase AWS API Documentation
|
|
966
|
+
#
|
|
967
|
+
# @overload resolve_case(params = {})
|
|
968
|
+
# @param [Hash] params ({})
|
|
969
|
+
def resolve_case(params = {}, options = {})
|
|
970
|
+
req = build_request(:resolve_case, params)
|
|
971
|
+
req.send_request(options)
|
|
972
|
+
end
|
|
835
973
|
|
|
836
|
-
|
|
837
|
-
# @api private
|
|
838
|
-
def build_request(operation_name, params = {})
|
|
839
|
-
handlers = @handlers.for(operation_name)
|
|
840
|
-
context = Seahorse::Client::RequestContext.new(
|
|
841
|
-
operation_name: operation_name,
|
|
842
|
-
operation: config.api.operation(operation_name),
|
|
843
|
-
client: self,
|
|
844
|
-
params: params,
|
|
845
|
-
config: config)
|
|
846
|
-
context[:gem_name] = 'aws-sdk-support'
|
|
847
|
-
context[:gem_version] = '1.0.0.rc1'
|
|
848
|
-
Seahorse::Client::Request.new(handlers, context)
|
|
849
|
-
end
|
|
974
|
+
# @!endgroup
|
|
850
975
|
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
976
|
+
# @param params ({})
|
|
977
|
+
# @api private
|
|
978
|
+
def build_request(operation_name, params = {})
|
|
979
|
+
handlers = @handlers.for(operation_name)
|
|
980
|
+
context = Seahorse::Client::RequestContext.new(
|
|
981
|
+
operation_name: operation_name,
|
|
982
|
+
operation: config.api.operation(operation_name),
|
|
983
|
+
client: self,
|
|
984
|
+
params: params,
|
|
985
|
+
config: config)
|
|
986
|
+
context[:gem_name] = 'aws-sdk-support'
|
|
987
|
+
context[:gem_version] = '1.0.0.rc2'
|
|
988
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
989
|
+
end
|
|
856
990
|
|
|
857
|
-
|
|
991
|
+
# @api private
|
|
992
|
+
# @deprecated
|
|
993
|
+
def waiter_names
|
|
994
|
+
[]
|
|
995
|
+
end
|
|
858
996
|
|
|
859
|
-
|
|
860
|
-
attr_reader :identifier
|
|
997
|
+
class << self
|
|
861
998
|
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
Errors
|
|
865
|
-
end
|
|
999
|
+
# @api private
|
|
1000
|
+
attr_reader :identifier
|
|
866
1001
|
|
|
1002
|
+
# @api private
|
|
1003
|
+
def errors_module
|
|
1004
|
+
Errors
|
|
867
1005
|
end
|
|
1006
|
+
|
|
868
1007
|
end
|
|
869
1008
|
end
|
|
870
1009
|
end
|