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.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module Support
10
- module Errors
8
+ module Aws::Support
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module Support
10
- class Resource
8
+ module Aws::Support
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,1085 +1,1261 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module Support
10
- module Types
8
+ module Aws::Support
9
+ module Types
11
10
 
12
- # @note When making an API call, pass AddAttachmentsToSetRequest
13
- # data as a hash:
14
- #
15
- # {
16
- # attachment_set_id: "AttachmentSetId",
17
- # attachments: [ # required
18
- # {
19
- # file_name: "FileName",
20
- # data: "data",
21
- # },
22
- # ],
23
- # }
24
- # @!attribute [rw] attachment_set_id
25
- # The ID of the attachment set. If an `attachmentSetId` is not
26
- # specified, a new attachment set is created, and the ID of the set is
27
- # returned in the response. If an `attachmentSetId` is specified, the
28
- # attachments are added to the specified set, if it exists.
29
- # @return [String]
30
- #
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.
34
- # @return [Array<Types::Attachment>]
35
- class AddAttachmentsToSetRequest < Struct.new(
36
- :attachment_set_id,
37
- :attachments)
38
- include Aws::Structure
39
- end
40
-
41
- # The ID and expiry time of the attachment set returned by the
42
- # AddAttachmentsToSet operation.
43
- # @!attribute [rw] attachment_set_id
44
- # The ID of the attachment set. If an `attachmentSetId` was not
45
- # specified, a new attachment set is created, and the ID of the set is
46
- # returned in the response. If an `attachmentSetId` was specified, the
47
- # attachments are added to the specified set, if it exists.
48
- # @return [String]
49
- #
50
- # @!attribute [rw] expiry_time
51
- # The time and date when the attachment set expires.
52
- # @return [String]
53
- class AddAttachmentsToSetResponse < Struct.new(
54
- :attachment_set_id,
55
- :expiry_time)
56
- include Aws::Structure
57
- end
11
+ # @note When making an API call, you may pass AddAttachmentsToSetRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # attachment_set_id: "AttachmentSetId",
16
+ # attachments: [ # required
17
+ # {
18
+ # file_name: "FileName",
19
+ # data: "data",
20
+ # },
21
+ # ],
22
+ # }
23
+ #
24
+ # @!attribute [rw] attachment_set_id
25
+ # The ID of the attachment set. If an `attachmentSetId` is not
26
+ # specified, a new attachment set is created, and the ID of the set is
27
+ # returned in the response. If an `attachmentSetId` is specified, the
28
+ # attachments are added to the specified set, if it exists.
29
+ # @return [String]
30
+ #
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.
34
+ # @return [Array<Types::Attachment>]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSetRequest AWS API Documentation
37
+ #
38
+ class AddAttachmentsToSetRequest < Struct.new(
39
+ :attachment_set_id,
40
+ :attachments)
41
+ include Aws::Structure
42
+ end
58
43
 
59
- # To be written.
60
- # @note When making an API call, pass AddCommunicationToCaseRequest
61
- # data as a hash:
62
- #
63
- # {
64
- # case_id: "CaseId",
65
- # communication_body: "CommunicationBody", # required
66
- # cc_email_addresses: ["CcEmailAddress"],
67
- # attachment_set_id: "AttachmentSetId",
68
- # }
69
- # @!attribute [rw] case_id
70
- # The AWS Support case ID requested or returned in the call. The case
71
- # ID is an alphanumeric string formatted as shown in this example:
72
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
73
- # @return [String]
74
- #
75
- # @!attribute [rw] communication_body
76
- # The body of an email communication to add to the support case.
77
- # @return [String]
78
- #
79
- # @!attribute [rw] cc_email_addresses
80
- # The email addresses in the CC line of an email to be added to the
81
- # support case.
82
- # @return [Array<String>]
83
- #
84
- # @!attribute [rw] attachment_set_id
85
- # The ID of a set of one or more attachments for the communication to
86
- # add to the case. Create the set by calling AddAttachmentsToSet
87
- # @return [String]
88
- class AddCommunicationToCaseRequest < Struct.new(
89
- :case_id,
90
- :communication_body,
91
- :cc_email_addresses,
92
- :attachment_set_id)
93
- include Aws::Structure
94
- end
44
+ # The ID and expiry time of the attachment set returned by the
45
+ # AddAttachmentsToSet operation.
46
+ #
47
+ # @!attribute [rw] attachment_set_id
48
+ # The ID of the attachment set. If an `attachmentSetId` was not
49
+ # specified, a new attachment set is created, and the ID of the set is
50
+ # returned in the response. If an `attachmentSetId` was specified, the
51
+ # attachments are added to the specified set, if it exists.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] expiry_time
55
+ # The time and date when the attachment set expires.
56
+ # @return [String]
57
+ #
58
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSetResponse AWS API Documentation
59
+ #
60
+ class AddAttachmentsToSetResponse < Struct.new(
61
+ :attachment_set_id,
62
+ :expiry_time)
63
+ include Aws::Structure
64
+ end
95
65
 
96
- # The result of the AddCommunicationToCase operation.
97
- # @!attribute [rw] result
98
- # True if AddCommunicationToCase succeeds. Otherwise, returns an
99
- # error.
100
- # @return [Boolean]
101
- class AddCommunicationToCaseResponse < Struct.new(
102
- :result)
103
- include Aws::Structure
104
- end
66
+ # To be written.
67
+ #
68
+ # @note When making an API call, you may pass AddCommunicationToCaseRequest
69
+ # data as a hash:
70
+ #
71
+ # {
72
+ # case_id: "CaseId",
73
+ # communication_body: "CommunicationBody", # required
74
+ # cc_email_addresses: ["CcEmailAddress"],
75
+ # attachment_set_id: "AttachmentSetId",
76
+ # }
77
+ #
78
+ # @!attribute [rw] case_id
79
+ # The AWS Support case ID requested or returned in the call. The case
80
+ # ID is an alphanumeric string formatted as shown in this example:
81
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
82
+ # @return [String]
83
+ #
84
+ # @!attribute [rw] communication_body
85
+ # The body of an email communication to add to the support case.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] cc_email_addresses
89
+ # The email addresses in the CC line of an email to be added to the
90
+ # support case.
91
+ # @return [Array<String>]
92
+ #
93
+ # @!attribute [rw] attachment_set_id
94
+ # The ID of a set of one or more attachments for the communication to
95
+ # add to the case. Create the set by calling AddAttachmentsToSet
96
+ # @return [String]
97
+ #
98
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCaseRequest AWS API Documentation
99
+ #
100
+ class AddCommunicationToCaseRequest < Struct.new(
101
+ :case_id,
102
+ :communication_body,
103
+ :cc_email_addresses,
104
+ :attachment_set_id)
105
+ include Aws::Structure
106
+ end
105
107
 
106
- # An attachment to a case communication. The attachment consists of the
107
- # file name and the content of the file.
108
- # @note When making an API call, pass Attachment
109
- # data as a hash:
110
- #
111
- # {
112
- # file_name: "FileName",
113
- # data: "data",
114
- # }
115
- # @!attribute [rw] file_name
116
- # The name of the attachment file.
117
- # @return [String]
118
- #
119
- # @!attribute [rw] data
120
- # The content of the attachment file.
121
- # @return [String]
122
- class Attachment < Struct.new(
123
- :file_name,
124
- :data)
125
- include Aws::Structure
126
- end
108
+ # The result of the AddCommunicationToCase operation.
109
+ #
110
+ # @!attribute [rw] result
111
+ # True if AddCommunicationToCase succeeds. Otherwise, returns an
112
+ # error.
113
+ # @return [Boolean]
114
+ #
115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCaseResponse AWS API Documentation
116
+ #
117
+ class AddCommunicationToCaseResponse < Struct.new(
118
+ :result)
119
+ include Aws::Structure
120
+ end
127
121
 
128
- # The file name and ID of an attachment to a case communication. You can
129
- # use the ID to retrieve the attachment with the DescribeAttachment
130
- # operation.
131
- # @!attribute [rw] attachment_id
132
- # The ID of the attachment.
133
- # @return [String]
134
- #
135
- # @!attribute [rw] file_name
136
- # The file name of the attachment.
137
- # @return [String]
138
- class AttachmentDetails < Struct.new(
139
- :attachment_id,
140
- :file_name)
141
- include Aws::Structure
142
- end
122
+ # An attachment to a case communication. The attachment consists of the
123
+ # file name and the content of the file.
124
+ #
125
+ # @note When making an API call, you may pass Attachment
126
+ # data as a hash:
127
+ #
128
+ # {
129
+ # file_name: "FileName",
130
+ # data: "data",
131
+ # }
132
+ #
133
+ # @!attribute [rw] file_name
134
+ # The name of the attachment file.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] data
138
+ # The content of the attachment file.
139
+ # @return [String]
140
+ #
141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Attachment AWS API Documentation
142
+ #
143
+ class Attachment < Struct.new(
144
+ :file_name,
145
+ :data)
146
+ include Aws::Structure
147
+ end
143
148
 
144
- # A JSON-formatted object that contains the metadata for a support case.
145
- # It is contained the response from a DescribeCases request.
146
- # **CaseDetails** contains the following fields:
147
- #
148
- # * **caseId.** The AWS Support case ID requested or returned in the
149
- # call. The case ID is an alphanumeric string formatted as shown in
150
- # this example: case-*12345678910-2013-c4c1d2bf33c5cf47*.
151
- #
152
- # * **categoryCode.** The category of problem for the AWS Support case.
153
- # Corresponds to the CategoryCode values returned by a call to
154
- # DescribeServices.
155
- #
156
- # * **displayId.** The identifier for the case on pages in the AWS
157
- # Support Center.
158
- #
159
- # * **language.** The ISO 639-1 code for the language in which AWS
160
- # provides support. AWS Support currently supports English ("en")
161
- # and Japanese ("ja"). Language parameters must be passed explicitly
162
- # for operations that take them.
163
- #
164
- # * **recentCommunications.** One or more Communication objects. Fields
165
- # of these objects are `attachments`, `body`, `caseId`, `submittedBy`,
166
- # and `timeCreated`.
167
- #
168
- # * **nextToken.** A resumption point for pagination.
169
- #
170
- # * **serviceCode.** The identifier for the AWS service that corresponds
171
- # to the service code defined in the call to DescribeServices.
172
- #
173
- # * <b>severityCode. </b>The severity code assigned to the case.
174
- # Contains one of the values returned by the call to
175
- # DescribeSeverityLevels.
176
- #
177
- # * **status.** The status of the case in the AWS Support Center.
178
- #
179
- # * **subject.** The subject line of the case.
180
- #
181
- # * **submittedBy.** The email address of the account that submitted the
182
- # case.
183
- #
184
- # * **timeCreated.** The time the case was created, in ISO-8601 format.
185
- # @!attribute [rw] case_id
186
- # The AWS Support case ID requested or returned in the call. The case
187
- # ID is an alphanumeric string formatted as shown in this example:
188
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
189
- # @return [String]
190
- #
191
- # @!attribute [rw] display_id
192
- # The ID displayed for the case in the AWS Support Center. This is a
193
- # numeric string.
194
- # @return [String]
195
- #
196
- # @!attribute [rw] subject
197
- # The subject line for the case in the AWS Support Center.
198
- # @return [String]
199
- #
200
- # @!attribute [rw] status
201
- # The status of the case.
202
- # @return [String]
203
- #
204
- # @!attribute [rw] service_code
205
- # The code for the AWS service returned by the call to
206
- # DescribeServices.
207
- # @return [String]
208
- #
209
- # @!attribute [rw] category_code
210
- # The category of problem for the AWS Support case.
211
- # @return [String]
212
- #
213
- # @!attribute [rw] severity_code
214
- # The code for the severity level returned by the call to
215
- # DescribeSeverityLevels.
216
- # @return [String]
217
- #
218
- # @!attribute [rw] submitted_by
219
- # The email address of the account that submitted the case.
220
- # @return [String]
221
- #
222
- # @!attribute [rw] time_created
223
- # The time that the case was case created in the AWS Support Center.
224
- # @return [String]
225
- #
226
- # @!attribute [rw] recent_communications
227
- # The five most recent communications between you and AWS Support
228
- # Center, including the IDs of any attachments to the communications.
229
- # Also includes a `nextToken` that you can use to retrieve earlier
230
- # communications.
231
- # @return [Types::RecentCaseCommunications]
232
- #
233
- # @!attribute [rw] cc_email_addresses
234
- # The email addresses that receive copies of communication about the
235
- # case.
236
- # @return [Array<String>]
237
- #
238
- # @!attribute [rw] language
239
- # The ISO 639-1 code for the language in which AWS provides support.
240
- # AWS Support currently supports English ("en") and Japanese
241
- # ("ja"). Language parameters must be passed explicitly for
242
- # operations that take them.
243
- # @return [String]
244
- class CaseDetails < Struct.new(
245
- :case_id,
246
- :display_id,
247
- :subject,
248
- :status,
249
- :service_code,
250
- :category_code,
251
- :severity_code,
252
- :submitted_by,
253
- :time_created,
254
- :recent_communications,
255
- :cc_email_addresses,
256
- :language)
257
- include Aws::Structure
258
- end
149
+ # The file name and ID of an attachment to a case communication. You can
150
+ # use the ID to retrieve the attachment with the DescribeAttachment
151
+ # operation.
152
+ #
153
+ # @!attribute [rw] attachment_id
154
+ # The ID of the attachment.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] file_name
158
+ # The file name of the attachment.
159
+ # @return [String]
160
+ #
161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentDetails AWS API Documentation
162
+ #
163
+ class AttachmentDetails < Struct.new(
164
+ :attachment_id,
165
+ :file_name)
166
+ include Aws::Structure
167
+ end
259
168
 
260
- # A JSON-formatted name/value pair that represents the category name and
261
- # category code of the problem, selected from the DescribeServices
262
- # response for each AWS service.
263
- # @!attribute [rw] code
264
- # The category code for the support case.
265
- # @return [String]
266
- #
267
- # @!attribute [rw] name
268
- # The category name for the support case.
269
- # @return [String]
270
- class Category < Struct.new(
271
- :code,
272
- :name)
273
- include Aws::Structure
274
- end
169
+ # A JSON-formatted object that contains the metadata for a support case.
170
+ # It is contained the response from a DescribeCases request.
171
+ # **CaseDetails** contains the following fields:
172
+ #
173
+ # * **caseId.** The AWS Support case ID requested or returned in the
174
+ # call. The case ID is an alphanumeric string formatted as shown in
175
+ # this example: case-*12345678910-2013-c4c1d2bf33c5cf47*.
176
+ #
177
+ # * **categoryCode.** The category of problem for the AWS Support case.
178
+ # Corresponds to the CategoryCode values returned by a call to
179
+ # DescribeServices.
180
+ #
181
+ # * **displayId.** The identifier for the case on pages in the AWS
182
+ # Support Center.
183
+ #
184
+ # * **language.** The ISO 639-1 code for the language in which AWS
185
+ # provides support. AWS Support currently supports English ("en")
186
+ # and Japanese ("ja"). Language parameters must be passed explicitly
187
+ # for operations that take them.
188
+ #
189
+ # * **recentCommunications.** One or more Communication objects. Fields
190
+ # of these objects are `attachments`, `body`, `caseId`, `submittedBy`,
191
+ # and `timeCreated`.
192
+ #
193
+ # * **nextToken.** A resumption point for pagination.
194
+ #
195
+ # * **serviceCode.** The identifier for the AWS service that corresponds
196
+ # to the service code defined in the call to DescribeServices.
197
+ #
198
+ # * <b>severityCode. </b>The severity code assigned to the case.
199
+ # Contains one of the values returned by the call to
200
+ # DescribeSeverityLevels.
201
+ #
202
+ # * **status.** The status of the case in the AWS Support Center.
203
+ #
204
+ # * **subject.** The subject line of the case.
205
+ #
206
+ # * **submittedBy.** The email address of the account that submitted the
207
+ # case.
208
+ #
209
+ # * **timeCreated.** The time the case was created, in ISO-8601 format.
210
+ #
211
+ # @!attribute [rw] case_id
212
+ # The AWS Support case ID requested or returned in the call. The case
213
+ # ID is an alphanumeric string formatted as shown in this example:
214
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] display_id
218
+ # The ID displayed for the case in the AWS Support Center. This is a
219
+ # numeric string.
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] subject
223
+ # The subject line for the case in the AWS Support Center.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] status
227
+ # The status of the case.
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] service_code
231
+ # The code for the AWS service returned by the call to
232
+ # DescribeServices.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] category_code
236
+ # The category of problem for the AWS Support case.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] severity_code
240
+ # The code for the severity level returned by the call to
241
+ # DescribeSeverityLevels.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] submitted_by
245
+ # The email address of the account that submitted the case.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] time_created
249
+ # The time that the case was case created in the AWS Support Center.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] recent_communications
253
+ # The five most recent communications between you and AWS Support
254
+ # Center, including the IDs of any attachments to the communications.
255
+ # Also includes a `nextToken` that you can use to retrieve earlier
256
+ # communications.
257
+ # @return [Types::RecentCaseCommunications]
258
+ #
259
+ # @!attribute [rw] cc_email_addresses
260
+ # The email addresses that receive copies of communication about the
261
+ # case.
262
+ # @return [Array<String>]
263
+ #
264
+ # @!attribute [rw] language
265
+ # The ISO 639-1 code for the language in which AWS provides support.
266
+ # AWS Support currently supports English ("en") and Japanese
267
+ # ("ja"). Language parameters must be passed explicitly for
268
+ # operations that take them.
269
+ # @return [String]
270
+ #
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CaseDetails AWS API Documentation
272
+ #
273
+ class CaseDetails < Struct.new(
274
+ :case_id,
275
+ :display_id,
276
+ :subject,
277
+ :status,
278
+ :service_code,
279
+ :category_code,
280
+ :severity_code,
281
+ :submitted_by,
282
+ :time_created,
283
+ :recent_communications,
284
+ :cc_email_addresses,
285
+ :language)
286
+ include Aws::Structure
287
+ end
275
288
 
276
- # A communication associated with an AWS Support case. The communication
277
- # consists of the case ID, the message body, attachment information, the
278
- # account email address, and the date and time of the communication.
279
- # @!attribute [rw] case_id
280
- # The AWS Support case ID requested or returned in the call. The case
281
- # ID is an alphanumeric string formatted as shown in this example:
282
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
283
- # @return [String]
284
- #
285
- # @!attribute [rw] body
286
- # The text of the communication between the customer and AWS Support.
287
- # @return [String]
288
- #
289
- # @!attribute [rw] submitted_by
290
- # The email address of the account that submitted the AWS Support
291
- # case.
292
- # @return [String]
293
- #
294
- # @!attribute [rw] time_created
295
- # The time the communication was created.
296
- # @return [String]
297
- #
298
- # @!attribute [rw] attachment_set
299
- # Information about the attachments to the case communication.
300
- # @return [Array<Types::AttachmentDetails>]
301
- class Communication < Struct.new(
302
- :case_id,
303
- :body,
304
- :submitted_by,
305
- :time_created,
306
- :attachment_set)
307
- include Aws::Structure
308
- end
289
+ # A JSON-formatted name/value pair that represents the category name and
290
+ # category code of the problem, selected from the DescribeServices
291
+ # response for each AWS service.
292
+ #
293
+ # @!attribute [rw] code
294
+ # The category code for the support case.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] name
298
+ # The category name for the support case.
299
+ # @return [String]
300
+ #
301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Category AWS API Documentation
302
+ #
303
+ class Category < Struct.new(
304
+ :code,
305
+ :name)
306
+ include Aws::Structure
307
+ end
309
308
 
310
- # @note When making an API call, pass CreateCaseRequest
311
- # data as a hash:
312
- #
313
- # {
314
- # subject: "Subject", # required
315
- # service_code: "ServiceCode",
316
- # severity_code: "SeverityCode",
317
- # category_code: "CategoryCode",
318
- # communication_body: "CommunicationBody", # required
319
- # cc_email_addresses: ["CcEmailAddress"],
320
- # language: "Language",
321
- # issue_type: "IssueType",
322
- # attachment_set_id: "AttachmentSetId",
323
- # }
324
- # @!attribute [rw] subject
325
- # The title of the AWS Support case.
326
- # @return [String]
327
- #
328
- # @!attribute [rw] service_code
329
- # The code for the AWS service returned by the call to
330
- # DescribeServices.
331
- # @return [String]
332
- #
333
- # @!attribute [rw] severity_code
334
- # The code for the severity level returned by the call to
335
- # DescribeSeverityLevels.
336
- #
337
- # <note markdown="1"> The availability of severity levels depends on each customer's
338
- # support subscription. In other words, your subscription may not
339
- # necessarily require the urgent level of response time.
340
- #
341
- # </note>
342
- # @return [String]
343
- #
344
- # @!attribute [rw] category_code
345
- # The category of problem for the AWS Support case.
346
- # @return [String]
347
- #
348
- # @!attribute [rw] communication_body
349
- # The communication body text when you create an AWS Support case by
350
- # calling CreateCase.
351
- # @return [String]
352
- #
353
- # @!attribute [rw] cc_email_addresses
354
- # A list of email addresses that AWS Support copies on case
355
- # correspondence.
356
- # @return [Array<String>]
357
- #
358
- # @!attribute [rw] language
359
- # The ISO 639-1 code for the language in which AWS provides support.
360
- # AWS Support currently supports English ("en") and Japanese
361
- # ("ja"). Language parameters must be passed explicitly for
362
- # operations that take them.
363
- # @return [String]
364
- #
365
- # @!attribute [rw] issue_type
366
- # The type of issue for the case. You can specify either
367
- # "customer-service" or "technical." If you do not indicate a
368
- # value, the default is "technical."
369
- # @return [String]
370
- #
371
- # @!attribute [rw] attachment_set_id
372
- # The ID of a set of one or more attachments for the case. Create the
373
- # set by using AddAttachmentsToSet.
374
- # @return [String]
375
- class CreateCaseRequest < Struct.new(
376
- :subject,
377
- :service_code,
378
- :severity_code,
379
- :category_code,
380
- :communication_body,
381
- :cc_email_addresses,
382
- :language,
383
- :issue_type,
384
- :attachment_set_id)
385
- include Aws::Structure
386
- end
309
+ # A communication associated with an AWS Support case. The communication
310
+ # consists of the case ID, the message body, attachment information, the
311
+ # account email address, and the date and time of the communication.
312
+ #
313
+ # @!attribute [rw] case_id
314
+ # The AWS Support case ID requested or returned in the call. The case
315
+ # ID is an alphanumeric string formatted as shown in this example:
316
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] body
320
+ # The text of the communication between the customer and AWS Support.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] submitted_by
324
+ # The email address of the account that submitted the AWS Support
325
+ # case.
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] time_created
329
+ # The time the communication was created.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] attachment_set
333
+ # Information about the attachments to the case communication.
334
+ # @return [Array<Types::AttachmentDetails>]
335
+ #
336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Communication AWS API Documentation
337
+ #
338
+ class Communication < Struct.new(
339
+ :case_id,
340
+ :body,
341
+ :submitted_by,
342
+ :time_created,
343
+ :attachment_set)
344
+ include Aws::Structure
345
+ end
387
346
 
388
- # The AWS Support case ID returned by a successful completion of the
389
- # CreateCase operation.
390
- # @!attribute [rw] case_id
391
- # The AWS Support case ID requested or returned in the call. The case
392
- # ID is an alphanumeric string formatted as shown in this example:
393
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
394
- # @return [String]
395
- class CreateCaseResponse < Struct.new(
396
- :case_id)
397
- include Aws::Structure
398
- end
347
+ # @note When making an API call, you may pass CreateCaseRequest
348
+ # data as a hash:
349
+ #
350
+ # {
351
+ # subject: "Subject", # required
352
+ # service_code: "ServiceCode",
353
+ # severity_code: "SeverityCode",
354
+ # category_code: "CategoryCode",
355
+ # communication_body: "CommunicationBody", # required
356
+ # cc_email_addresses: ["CcEmailAddress"],
357
+ # language: "Language",
358
+ # issue_type: "IssueType",
359
+ # attachment_set_id: "AttachmentSetId",
360
+ # }
361
+ #
362
+ # @!attribute [rw] subject
363
+ # The title of the AWS Support case.
364
+ # @return [String]
365
+ #
366
+ # @!attribute [rw] service_code
367
+ # The code for the AWS service returned by the call to
368
+ # DescribeServices.
369
+ # @return [String]
370
+ #
371
+ # @!attribute [rw] severity_code
372
+ # The code for the severity level returned by the call to
373
+ # DescribeSeverityLevels.
374
+ #
375
+ # <note markdown="1"> The availability of severity levels depends on each customer's
376
+ # support subscription. In other words, your subscription may not
377
+ # necessarily require the urgent level of response time.
378
+ #
379
+ # </note>
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] category_code
383
+ # The category of problem for the AWS Support case.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] communication_body
387
+ # The communication body text when you create an AWS Support case by
388
+ # calling CreateCase.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] cc_email_addresses
392
+ # A list of email addresses that AWS Support copies on case
393
+ # correspondence.
394
+ # @return [Array<String>]
395
+ #
396
+ # @!attribute [rw] language
397
+ # The ISO 639-1 code for the language in which AWS provides support.
398
+ # AWS Support currently supports English ("en") and Japanese
399
+ # ("ja"). Language parameters must be passed explicitly for
400
+ # operations that take them.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] issue_type
404
+ # The type of issue for the case. You can specify either
405
+ # "customer-service" or "technical." If you do not indicate a
406
+ # value, the default is "technical."
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] attachment_set_id
410
+ # The ID of a set of one or more attachments for the case. Create the
411
+ # set by using AddAttachmentsToSet.
412
+ # @return [String]
413
+ #
414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCaseRequest AWS API Documentation
415
+ #
416
+ class CreateCaseRequest < Struct.new(
417
+ :subject,
418
+ :service_code,
419
+ :severity_code,
420
+ :category_code,
421
+ :communication_body,
422
+ :cc_email_addresses,
423
+ :language,
424
+ :issue_type,
425
+ :attachment_set_id)
426
+ include Aws::Structure
427
+ end
399
428
 
400
- # @note When making an API call, pass DescribeAttachmentRequest
401
- # data as a hash:
402
- #
403
- # {
404
- # attachment_id: "AttachmentId", # required
405
- # }
406
- # @!attribute [rw] attachment_id
407
- # The ID of the attachment to return. Attachment IDs are returned by
408
- # the DescribeCommunications operation.
409
- # @return [String]
410
- class DescribeAttachmentRequest < Struct.new(
411
- :attachment_id)
412
- include Aws::Structure
413
- end
429
+ # The AWS Support case ID returned by a successful completion of the
430
+ # CreateCase operation.
431
+ #
432
+ # @!attribute [rw] case_id
433
+ # The AWS Support case ID requested or returned in the call. The case
434
+ # ID is an alphanumeric string formatted as shown in this example:
435
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
436
+ # @return [String]
437
+ #
438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCaseResponse AWS API Documentation
439
+ #
440
+ class CreateCaseResponse < Struct.new(
441
+ :case_id)
442
+ include Aws::Structure
443
+ end
414
444
 
415
- # The content and file name of the attachment returned by the
416
- # DescribeAttachment operation.
417
- # @!attribute [rw] attachment
418
- # The attachment content and file name.
419
- # @return [Types::Attachment]
420
- class DescribeAttachmentResponse < Struct.new(
421
- :attachment)
422
- include Aws::Structure
423
- end
445
+ # @note When making an API call, you may pass DescribeAttachmentRequest
446
+ # data as a hash:
447
+ #
448
+ # {
449
+ # attachment_id: "AttachmentId", # required
450
+ # }
451
+ #
452
+ # @!attribute [rw] attachment_id
453
+ # The ID of the attachment to return. Attachment IDs are returned by
454
+ # the DescribeCommunications operation.
455
+ # @return [String]
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentRequest AWS API Documentation
458
+ #
459
+ class DescribeAttachmentRequest < Struct.new(
460
+ :attachment_id)
461
+ include Aws::Structure
462
+ end
424
463
 
425
- # @note When making an API call, pass DescribeCasesRequest
426
- # data as a hash:
427
- #
428
- # {
429
- # case_id_list: ["CaseId"],
430
- # display_id: "DisplayId",
431
- # after_time: "AfterTime",
432
- # before_time: "BeforeTime",
433
- # include_resolved_cases: false,
434
- # next_token: "NextToken",
435
- # max_results: 1,
436
- # language: "Language",
437
- # include_communications: false,
438
- # }
439
- # @!attribute [rw] case_id_list
440
- # A list of ID numbers of the support cases you want returned. The
441
- # maximum number of cases is 100.
442
- # @return [Array<String>]
443
- #
444
- # @!attribute [rw] display_id
445
- # The ID displayed for a case in the AWS Support Center user
446
- # interface.
447
- # @return [String]
448
- #
449
- # @!attribute [rw] after_time
450
- # The start date for a filtered date search on support case
451
- # communications. Case communications are available for 12 months
452
- # after creation.
453
- # @return [String]
454
- #
455
- # @!attribute [rw] before_time
456
- # The end date for a filtered date search on support case
457
- # communications. Case communications are available for 12 months
458
- # after creation.
459
- # @return [String]
460
- #
461
- # @!attribute [rw] include_resolved_cases
462
- # Specifies whether resolved support cases should be included in the
463
- # DescribeCases results. The default is *false*.
464
- # @return [Boolean]
465
- #
466
- # @!attribute [rw] next_token
467
- # A resumption point for pagination.
468
- # @return [String]
469
- #
470
- # @!attribute [rw] max_results
471
- # The maximum number of results to return before paginating.
472
- # @return [Integer]
473
- #
474
- # @!attribute [rw] language
475
- # The ISO 639-1 code for the language in which AWS provides support.
476
- # AWS Support currently supports English ("en") and Japanese
477
- # ("ja"). Language parameters must be passed explicitly for
478
- # operations that take them.
479
- # @return [String]
480
- #
481
- # @!attribute [rw] include_communications
482
- # Specifies whether communications should be included in the
483
- # DescribeCases results. The default is *true*.
484
- # @return [Boolean]
485
- class DescribeCasesRequest < Struct.new(
486
- :case_id_list,
487
- :display_id,
488
- :after_time,
489
- :before_time,
490
- :include_resolved_cases,
491
- :next_token,
492
- :max_results,
493
- :language,
494
- :include_communications)
495
- include Aws::Structure
496
- end
464
+ # The content and file name of the attachment returned by the
465
+ # DescribeAttachment operation.
466
+ #
467
+ # @!attribute [rw] attachment
468
+ # The attachment content and file name.
469
+ # @return [Types::Attachment]
470
+ #
471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentResponse AWS API Documentation
472
+ #
473
+ class DescribeAttachmentResponse < Struct.new(
474
+ :attachment)
475
+ include Aws::Structure
476
+ end
497
477
 
498
- # Returns an array of CaseDetails objects and a `nextToken` that defines
499
- # a point for pagination in the result set.
500
- # @!attribute [rw] cases
501
- # The details for the cases that match the request.
502
- # @return [Array<Types::CaseDetails>]
503
- #
504
- # @!attribute [rw] next_token
505
- # A resumption point for pagination.
506
- # @return [String]
507
- class DescribeCasesResponse < Struct.new(
508
- :cases,
509
- :next_token)
510
- include Aws::Structure
511
- end
478
+ # @note When making an API call, you may pass DescribeCasesRequest
479
+ # data as a hash:
480
+ #
481
+ # {
482
+ # case_id_list: ["CaseId"],
483
+ # display_id: "DisplayId",
484
+ # after_time: "AfterTime",
485
+ # before_time: "BeforeTime",
486
+ # include_resolved_cases: false,
487
+ # next_token: "NextToken",
488
+ # max_results: 1,
489
+ # language: "Language",
490
+ # include_communications: false,
491
+ # }
492
+ #
493
+ # @!attribute [rw] case_id_list
494
+ # A list of ID numbers of the support cases you want returned. The
495
+ # maximum number of cases is 100.
496
+ # @return [Array<String>]
497
+ #
498
+ # @!attribute [rw] display_id
499
+ # The ID displayed for a case in the AWS Support Center user
500
+ # interface.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] after_time
504
+ # The start date for a filtered date search on support case
505
+ # communications. Case communications are available for 12 months
506
+ # after creation.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] before_time
510
+ # The end date for a filtered date search on support case
511
+ # communications. Case communications are available for 12 months
512
+ # after creation.
513
+ # @return [String]
514
+ #
515
+ # @!attribute [rw] include_resolved_cases
516
+ # Specifies whether resolved support cases should be included in the
517
+ # DescribeCases results. The default is *false*.
518
+ # @return [Boolean]
519
+ #
520
+ # @!attribute [rw] next_token
521
+ # A resumption point for pagination.
522
+ # @return [String]
523
+ #
524
+ # @!attribute [rw] max_results
525
+ # The maximum number of results to return before paginating.
526
+ # @return [Integer]
527
+ #
528
+ # @!attribute [rw] language
529
+ # The ISO 639-1 code for the language in which AWS provides support.
530
+ # AWS Support currently supports English ("en") and Japanese
531
+ # ("ja"). Language parameters must be passed explicitly for
532
+ # operations that take them.
533
+ # @return [String]
534
+ #
535
+ # @!attribute [rw] include_communications
536
+ # Specifies whether communications should be included in the
537
+ # DescribeCases results. The default is *true*.
538
+ # @return [Boolean]
539
+ #
540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCasesRequest AWS API Documentation
541
+ #
542
+ class DescribeCasesRequest < Struct.new(
543
+ :case_id_list,
544
+ :display_id,
545
+ :after_time,
546
+ :before_time,
547
+ :include_resolved_cases,
548
+ :next_token,
549
+ :max_results,
550
+ :language,
551
+ :include_communications)
552
+ include Aws::Structure
553
+ end
512
554
 
513
- # @note When making an API call, pass DescribeCommunicationsRequest
514
- # data as a hash:
515
- #
516
- # {
517
- # case_id: "CaseId", # required
518
- # before_time: "BeforeTime",
519
- # after_time: "AfterTime",
520
- # next_token: "NextToken",
521
- # max_results: 1,
522
- # }
523
- # @!attribute [rw] case_id
524
- # The AWS Support case ID requested or returned in the call. The case
525
- # ID is an alphanumeric string formatted as shown in this example:
526
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
527
- # @return [String]
528
- #
529
- # @!attribute [rw] before_time
530
- # The end date for a filtered date search on support case
531
- # communications. Case communications are available for 12 months
532
- # after creation.
533
- # @return [String]
534
- #
535
- # @!attribute [rw] after_time
536
- # The start date for a filtered date search on support case
537
- # communications. Case communications are available for 12 months
538
- # after creation.
539
- # @return [String]
540
- #
541
- # @!attribute [rw] next_token
542
- # A resumption point for pagination.
543
- # @return [String]
544
- #
545
- # @!attribute [rw] max_results
546
- # The maximum number of results to return before paginating.
547
- # @return [Integer]
548
- class DescribeCommunicationsRequest < Struct.new(
549
- :case_id,
550
- :before_time,
551
- :after_time,
552
- :next_token,
553
- :max_results)
554
- include Aws::Structure
555
- end
555
+ # Returns an array of CaseDetails objects and a `nextToken` that defines
556
+ # a point for pagination in the result set.
557
+ #
558
+ # @!attribute [rw] cases
559
+ # The details for the cases that match the request.
560
+ # @return [Array<Types::CaseDetails>]
561
+ #
562
+ # @!attribute [rw] next_token
563
+ # A resumption point for pagination.
564
+ # @return [String]
565
+ #
566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCasesResponse AWS API Documentation
567
+ #
568
+ class DescribeCasesResponse < Struct.new(
569
+ :cases,
570
+ :next_token)
571
+ include Aws::Structure
572
+ end
556
573
 
557
- # The communications returned by the DescribeCommunications operation.
558
- # @!attribute [rw] communications
559
- # The communications for the case.
560
- # @return [Array<Types::Communication>]
561
- #
562
- # @!attribute [rw] next_token
563
- # A resumption point for pagination.
564
- # @return [String]
565
- class DescribeCommunicationsResponse < Struct.new(
566
- :communications,
567
- :next_token)
568
- include Aws::Structure
569
- end
574
+ # @note When making an API call, you may pass DescribeCommunicationsRequest
575
+ # data as a hash:
576
+ #
577
+ # {
578
+ # case_id: "CaseId", # required
579
+ # before_time: "BeforeTime",
580
+ # after_time: "AfterTime",
581
+ # next_token: "NextToken",
582
+ # max_results: 1,
583
+ # }
584
+ #
585
+ # @!attribute [rw] case_id
586
+ # The AWS Support case ID requested or returned in the call. The case
587
+ # ID is an alphanumeric string formatted as shown in this example:
588
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] before_time
592
+ # The end date for a filtered date search on support case
593
+ # communications. Case communications are available for 12 months
594
+ # after creation.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] after_time
598
+ # The start date for a filtered date search on support case
599
+ # communications. Case communications are available for 12 months
600
+ # after creation.
601
+ # @return [String]
602
+ #
603
+ # @!attribute [rw] next_token
604
+ # A resumption point for pagination.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] max_results
608
+ # The maximum number of results to return before paginating.
609
+ # @return [Integer]
610
+ #
611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunicationsRequest AWS API Documentation
612
+ #
613
+ class DescribeCommunicationsRequest < Struct.new(
614
+ :case_id,
615
+ :before_time,
616
+ :after_time,
617
+ :next_token,
618
+ :max_results)
619
+ include Aws::Structure
620
+ end
570
621
 
571
- # @note When making an API call, pass DescribeServicesRequest
572
- # data as a hash:
573
- #
574
- # {
575
- # service_code_list: ["ServiceCode"],
576
- # language: "Language",
577
- # }
578
- # @!attribute [rw] service_code_list
579
- # A JSON-formatted list of service codes available for AWS services.
580
- # @return [Array<String>]
581
- #
582
- # @!attribute [rw] language
583
- # The ISO 639-1 code for the language in which AWS provides support.
584
- # AWS Support currently supports English ("en") and Japanese
585
- # ("ja"). Language parameters must be passed explicitly for
586
- # operations that take them.
587
- # @return [String]
588
- class DescribeServicesRequest < Struct.new(
589
- :service_code_list,
590
- :language)
591
- include Aws::Structure
592
- end
622
+ # The communications returned by the DescribeCommunications operation.
623
+ #
624
+ # @!attribute [rw] communications
625
+ # The communications for the case.
626
+ # @return [Array<Types::Communication>]
627
+ #
628
+ # @!attribute [rw] next_token
629
+ # A resumption point for pagination.
630
+ # @return [String]
631
+ #
632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunicationsResponse AWS API Documentation
633
+ #
634
+ class DescribeCommunicationsResponse < Struct.new(
635
+ :communications,
636
+ :next_token)
637
+ include Aws::Structure
638
+ end
593
639
 
594
- # The list of AWS services returned by the DescribeServices operation.
595
- # @!attribute [rw] services
596
- # A JSON-formatted list of AWS services.
597
- # @return [Array<Types::Service>]
598
- class DescribeServicesResponse < Struct.new(
599
- :services)
600
- include Aws::Structure
601
- end
640
+ # @note When making an API call, you may pass DescribeServicesRequest
641
+ # data as a hash:
642
+ #
643
+ # {
644
+ # service_code_list: ["ServiceCode"],
645
+ # language: "Language",
646
+ # }
647
+ #
648
+ # @!attribute [rw] service_code_list
649
+ # A JSON-formatted list of service codes available for AWS services.
650
+ # @return [Array<String>]
651
+ #
652
+ # @!attribute [rw] language
653
+ # The ISO 639-1 code for the language in which AWS provides support.
654
+ # AWS Support currently supports English ("en") and Japanese
655
+ # ("ja"). Language parameters must be passed explicitly for
656
+ # operations that take them.
657
+ # @return [String]
658
+ #
659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServicesRequest AWS API Documentation
660
+ #
661
+ class DescribeServicesRequest < Struct.new(
662
+ :service_code_list,
663
+ :language)
664
+ include Aws::Structure
665
+ end
602
666
 
603
- # @note When making an API call, pass DescribeSeverityLevelsRequest
604
- # data as a hash:
605
- #
606
- # {
607
- # language: "Language",
608
- # }
609
- # @!attribute [rw] language
610
- # The ISO 639-1 code for the language in which AWS provides support.
611
- # AWS Support currently supports English ("en") and Japanese
612
- # ("ja"). Language parameters must be passed explicitly for
613
- # operations that take them.
614
- # @return [String]
615
- class DescribeSeverityLevelsRequest < Struct.new(
616
- :language)
617
- include Aws::Structure
618
- end
667
+ # The list of AWS services returned by the DescribeServices operation.
668
+ #
669
+ # @!attribute [rw] services
670
+ # A JSON-formatted list of AWS services.
671
+ # @return [Array<Types::Service>]
672
+ #
673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServicesResponse AWS API Documentation
674
+ #
675
+ class DescribeServicesResponse < Struct.new(
676
+ :services)
677
+ include Aws::Structure
678
+ end
619
679
 
620
- # The list of severity levels returned by the DescribeSeverityLevels
621
- # operation.
622
- # @!attribute [rw] severity_levels
623
- # The available severity levels for the support case. Available
624
- # severity levels are defined by your service level agreement with
625
- # AWS.
626
- # @return [Array<Types::SeverityLevel>]
627
- class DescribeSeverityLevelsResponse < Struct.new(
628
- :severity_levels)
629
- include Aws::Structure
630
- end
680
+ # @note When making an API call, you may pass DescribeSeverityLevelsRequest
681
+ # data as a hash:
682
+ #
683
+ # {
684
+ # language: "Language",
685
+ # }
686
+ #
687
+ # @!attribute [rw] language
688
+ # The ISO 639-1 code for the language in which AWS provides support.
689
+ # AWS Support currently supports English ("en") and Japanese
690
+ # ("ja"). Language parameters must be passed explicitly for
691
+ # operations that take them.
692
+ # @return [String]
693
+ #
694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevelsRequest AWS API Documentation
695
+ #
696
+ class DescribeSeverityLevelsRequest < Struct.new(
697
+ :language)
698
+ include Aws::Structure
699
+ end
631
700
 
632
- # @note When making an API call, pass DescribeTrustedAdvisorCheckRefreshStatusesRequest
633
- # data as a hash:
634
- #
635
- # {
636
- # check_ids: ["String"], # required
637
- # }
638
- # @!attribute [rw] check_ids
639
- # The IDs of the Trusted Advisor checks to get the status of.
640
- # **Note:** Specifying the check ID of a check that is automatically
641
- # refreshed causes an `InvalidParameterValue` error.
642
- # @return [Array<String>]
643
- class DescribeTrustedAdvisorCheckRefreshStatusesRequest < Struct.new(
644
- :check_ids)
645
- include Aws::Structure
646
- end
701
+ # The list of severity levels returned by the DescribeSeverityLevels
702
+ # operation.
703
+ #
704
+ # @!attribute [rw] severity_levels
705
+ # The available severity levels for the support case. Available
706
+ # severity levels are defined by your service level agreement with
707
+ # AWS.
708
+ # @return [Array<Types::SeverityLevel>]
709
+ #
710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevelsResponse AWS API Documentation
711
+ #
712
+ class DescribeSeverityLevelsResponse < Struct.new(
713
+ :severity_levels)
714
+ include Aws::Structure
715
+ end
647
716
 
648
- # The statuses of the Trusted Advisor checks returned by the
649
- # DescribeTrustedAdvisorCheckRefreshStatuses operation.
650
- # @!attribute [rw] statuses
651
- # The refresh status of the specified Trusted Advisor checks.
652
- # @return [Array<Types::TrustedAdvisorCheckRefreshStatus>]
653
- class DescribeTrustedAdvisorCheckRefreshStatusesResponse < Struct.new(
654
- :statuses)
655
- include Aws::Structure
656
- end
717
+ # @note When making an API call, you may pass DescribeTrustedAdvisorCheckRefreshStatusesRequest
718
+ # data as a hash:
719
+ #
720
+ # {
721
+ # check_ids: ["String"], # required
722
+ # }
723
+ #
724
+ # @!attribute [rw] check_ids
725
+ # The IDs of the Trusted Advisor checks to get the status of.
726
+ # **Note:** Specifying the check ID of a check that is automatically
727
+ # refreshed causes an `InvalidParameterValue` error.
728
+ # @return [Array<String>]
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatusesRequest AWS API Documentation
731
+ #
732
+ class DescribeTrustedAdvisorCheckRefreshStatusesRequest < Struct.new(
733
+ :check_ids)
734
+ include Aws::Structure
735
+ end
657
736
 
658
- # @note When making an API call, pass DescribeTrustedAdvisorCheckResultRequest
659
- # data as a hash:
660
- #
661
- # {
662
- # check_id: "String", # required
663
- # language: "String",
664
- # }
665
- # @!attribute [rw] check_id
666
- # The unique identifier for the Trusted Advisor check.
667
- # @return [String]
668
- #
669
- # @!attribute [rw] language
670
- # The ISO 639-1 code for the language in which AWS provides support.
671
- # AWS Support currently supports English ("en") and Japanese
672
- # ("ja"). Language parameters must be passed explicitly for
673
- # operations that take them.
674
- # @return [String]
675
- class DescribeTrustedAdvisorCheckResultRequest < Struct.new(
676
- :check_id,
677
- :language)
678
- include Aws::Structure
679
- end
737
+ # The statuses of the Trusted Advisor checks returned by the
738
+ # DescribeTrustedAdvisorCheckRefreshStatuses operation.
739
+ #
740
+ # @!attribute [rw] statuses
741
+ # The refresh status of the specified Trusted Advisor checks.
742
+ # @return [Array<Types::TrustedAdvisorCheckRefreshStatus>]
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatusesResponse AWS API Documentation
745
+ #
746
+ class DescribeTrustedAdvisorCheckRefreshStatusesResponse < Struct.new(
747
+ :statuses)
748
+ include Aws::Structure
749
+ end
680
750
 
681
- # The result of the Trusted Advisor check returned by the
682
- # DescribeTrustedAdvisorCheckResult operation.
683
- # @!attribute [rw] result
684
- # The detailed results of the Trusted Advisor check.
685
- # @return [Types::TrustedAdvisorCheckResult]
686
- class DescribeTrustedAdvisorCheckResultResponse < Struct.new(
687
- :result)
688
- include Aws::Structure
689
- end
751
+ # @note When making an API call, you may pass DescribeTrustedAdvisorCheckResultRequest
752
+ # data as a hash:
753
+ #
754
+ # {
755
+ # check_id: "String", # required
756
+ # language: "String",
757
+ # }
758
+ #
759
+ # @!attribute [rw] check_id
760
+ # The unique identifier for the Trusted Advisor check.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] language
764
+ # The ISO 639-1 code for the language in which AWS provides support.
765
+ # AWS Support currently supports English ("en") and Japanese
766
+ # ("ja"). Language parameters must be passed explicitly for
767
+ # operations that take them.
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResultRequest AWS API Documentation
771
+ #
772
+ class DescribeTrustedAdvisorCheckResultRequest < Struct.new(
773
+ :check_id,
774
+ :language)
775
+ include Aws::Structure
776
+ end
690
777
 
691
- # @note When making an API call, pass DescribeTrustedAdvisorCheckSummariesRequest
692
- # data as a hash:
693
- #
694
- # {
695
- # check_ids: ["String"], # required
696
- # }
697
- # @!attribute [rw] check_ids
698
- # The IDs of the Trusted Advisor checks.
699
- # @return [Array<String>]
700
- class DescribeTrustedAdvisorCheckSummariesRequest < Struct.new(
701
- :check_ids)
702
- include Aws::Structure
703
- end
778
+ # The result of the Trusted Advisor check returned by the
779
+ # DescribeTrustedAdvisorCheckResult operation.
780
+ #
781
+ # @!attribute [rw] result
782
+ # The detailed results of the Trusted Advisor check.
783
+ # @return [Types::TrustedAdvisorCheckResult]
784
+ #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResultResponse AWS API Documentation
786
+ #
787
+ class DescribeTrustedAdvisorCheckResultResponse < Struct.new(
788
+ :result)
789
+ include Aws::Structure
790
+ end
704
791
 
705
- # The summaries of the Trusted Advisor checks returned by the
706
- # DescribeTrustedAdvisorCheckSummaries operation.
707
- # @!attribute [rw] summaries
708
- # The summary information for the requested Trusted Advisor checks.
709
- # @return [Array<Types::TrustedAdvisorCheckSummary>]
710
- class DescribeTrustedAdvisorCheckSummariesResponse < Struct.new(
711
- :summaries)
712
- include Aws::Structure
713
- end
792
+ # @note When making an API call, you may pass DescribeTrustedAdvisorCheckSummariesRequest
793
+ # data as a hash:
794
+ #
795
+ # {
796
+ # check_ids: ["String"], # required
797
+ # }
798
+ #
799
+ # @!attribute [rw] check_ids
800
+ # The IDs of the Trusted Advisor checks.
801
+ # @return [Array<String>]
802
+ #
803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummariesRequest AWS API Documentation
804
+ #
805
+ class DescribeTrustedAdvisorCheckSummariesRequest < Struct.new(
806
+ :check_ids)
807
+ include Aws::Structure
808
+ end
714
809
 
715
- # @note When making an API call, pass DescribeTrustedAdvisorChecksRequest
716
- # data as a hash:
717
- #
718
- # {
719
- # language: "String", # required
720
- # }
721
- # @!attribute [rw] language
722
- # The ISO 639-1 code for the language in which AWS provides support.
723
- # AWS Support currently supports English ("en") and Japanese
724
- # ("ja"). Language parameters must be passed explicitly for
725
- # operations that take them.
726
- # @return [String]
727
- class DescribeTrustedAdvisorChecksRequest < Struct.new(
728
- :language)
729
- include Aws::Structure
730
- end
810
+ # The summaries of the Trusted Advisor checks returned by the
811
+ # DescribeTrustedAdvisorCheckSummaries operation.
812
+ #
813
+ # @!attribute [rw] summaries
814
+ # The summary information for the requested Trusted Advisor checks.
815
+ # @return [Array<Types::TrustedAdvisorCheckSummary>]
816
+ #
817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummariesResponse AWS API Documentation
818
+ #
819
+ class DescribeTrustedAdvisorCheckSummariesResponse < Struct.new(
820
+ :summaries)
821
+ include Aws::Structure
822
+ end
731
823
 
732
- # Information about the Trusted Advisor checks returned by the
733
- # DescribeTrustedAdvisorChecks operation.
734
- # @!attribute [rw] checks
735
- # Information about all available Trusted Advisor checks.
736
- # @return [Array<Types::TrustedAdvisorCheckDescription>]
737
- class DescribeTrustedAdvisorChecksResponse < Struct.new(
738
- :checks)
739
- include Aws::Structure
740
- end
824
+ # @note When making an API call, you may pass DescribeTrustedAdvisorChecksRequest
825
+ # data as a hash:
826
+ #
827
+ # {
828
+ # language: "String", # required
829
+ # }
830
+ #
831
+ # @!attribute [rw] language
832
+ # The ISO 639-1 code for the language in which AWS provides support.
833
+ # AWS Support currently supports English ("en") and Japanese
834
+ # ("ja"). Language parameters must be passed explicitly for
835
+ # operations that take them.
836
+ # @return [String]
837
+ #
838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecksRequest AWS API Documentation
839
+ #
840
+ class DescribeTrustedAdvisorChecksRequest < Struct.new(
841
+ :language)
842
+ include Aws::Structure
843
+ end
741
844
 
742
- # The five most recent communications associated with the case.
743
- # @!attribute [rw] communications
744
- # The five most recent communications associated with the case.
745
- # @return [Array<Types::Communication>]
746
- #
747
- # @!attribute [rw] next_token
748
- # A resumption point for pagination.
749
- # @return [String]
750
- class RecentCaseCommunications < Struct.new(
751
- :communications,
752
- :next_token)
753
- include Aws::Structure
754
- end
845
+ # Information about the Trusted Advisor checks returned by the
846
+ # DescribeTrustedAdvisorChecks operation.
847
+ #
848
+ # @!attribute [rw] checks
849
+ # Information about all available Trusted Advisor checks.
850
+ # @return [Array<Types::TrustedAdvisorCheckDescription>]
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecksResponse AWS API Documentation
853
+ #
854
+ class DescribeTrustedAdvisorChecksResponse < Struct.new(
855
+ :checks)
856
+ include Aws::Structure
857
+ end
755
858
 
756
- # @note When making an API call, pass RefreshTrustedAdvisorCheckRequest
757
- # data as a hash:
758
- #
759
- # {
760
- # check_id: "String", # required
761
- # }
762
- # @!attribute [rw] check_id
763
- # The unique identifier for the Trusted Advisor check to refresh.
764
- # **Note:** Specifying the check ID of a check that is automatically
765
- # refreshed causes an `InvalidParameterValue` error.
766
- # @return [String]
767
- class RefreshTrustedAdvisorCheckRequest < Struct.new(
768
- :check_id)
769
- include Aws::Structure
770
- end
859
+ # The five most recent communications associated with the case.
860
+ #
861
+ # @!attribute [rw] communications
862
+ # The five most recent communications associated with the case.
863
+ # @return [Array<Types::Communication>]
864
+ #
865
+ # @!attribute [rw] next_token
866
+ # A resumption point for pagination.
867
+ # @return [String]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RecentCaseCommunications AWS API Documentation
870
+ #
871
+ class RecentCaseCommunications < Struct.new(
872
+ :communications,
873
+ :next_token)
874
+ include Aws::Structure
875
+ end
771
876
 
772
- # The current refresh status of a Trusted Advisor check.
773
- # @!attribute [rw] status
774
- # The current refresh status for a check, including the amount of time
775
- # until the check is eligible for refresh.
776
- # @return [Types::TrustedAdvisorCheckRefreshStatus]
777
- class RefreshTrustedAdvisorCheckResponse < Struct.new(
778
- :status)
779
- include Aws::Structure
780
- end
877
+ # @note When making an API call, you may pass RefreshTrustedAdvisorCheckRequest
878
+ # data as a hash:
879
+ #
880
+ # {
881
+ # check_id: "String", # required
882
+ # }
883
+ #
884
+ # @!attribute [rw] check_id
885
+ # The unique identifier for the Trusted Advisor check to refresh.
886
+ # **Note:** Specifying the check ID of a check that is automatically
887
+ # refreshed causes an `InvalidParameterValue` error.
888
+ # @return [String]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckRequest AWS API Documentation
891
+ #
892
+ class RefreshTrustedAdvisorCheckRequest < Struct.new(
893
+ :check_id)
894
+ include Aws::Structure
895
+ end
781
896
 
782
- # @note When making an API call, pass ResolveCaseRequest
783
- # data as a hash:
784
- #
785
- # {
786
- # case_id: "CaseId",
787
- # }
788
- # @!attribute [rw] case_id
789
- # The AWS Support case ID requested or returned in the call. The case
790
- # ID is an alphanumeric string formatted as shown in this example:
791
- # case-*12345678910-2013-c4c1d2bf33c5cf47*
792
- # @return [String]
793
- class ResolveCaseRequest < Struct.new(
794
- :case_id)
795
- include Aws::Structure
796
- end
897
+ # The current refresh status of a Trusted Advisor check.
898
+ #
899
+ # @!attribute [rw] status
900
+ # The current refresh status for a check, including the amount of time
901
+ # until the check is eligible for refresh.
902
+ # @return [Types::TrustedAdvisorCheckRefreshStatus]
903
+ #
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckResponse AWS API Documentation
905
+ #
906
+ class RefreshTrustedAdvisorCheckResponse < Struct.new(
907
+ :status)
908
+ include Aws::Structure
909
+ end
797
910
 
798
- # The status of the case returned by the ResolveCase operation.
799
- # @!attribute [rw] initial_case_status
800
- # The status of the case when the ResolveCase request was sent.
801
- # @return [String]
802
- #
803
- # @!attribute [rw] final_case_status
804
- # The status of the case after the ResolveCase request was processed.
805
- # @return [String]
806
- class ResolveCaseResponse < Struct.new(
807
- :initial_case_status,
808
- :final_case_status)
809
- include Aws::Structure
810
- end
911
+ # @note When making an API call, you may pass ResolveCaseRequest
912
+ # data as a hash:
913
+ #
914
+ # {
915
+ # case_id: "CaseId",
916
+ # }
917
+ #
918
+ # @!attribute [rw] case_id
919
+ # The AWS Support case ID requested or returned in the call. The case
920
+ # ID is an alphanumeric string formatted as shown in this example:
921
+ # case-*12345678910-2013-c4c1d2bf33c5cf47*
922
+ # @return [String]
923
+ #
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCaseRequest AWS API Documentation
925
+ #
926
+ class ResolveCaseRequest < Struct.new(
927
+ :case_id)
928
+ include Aws::Structure
929
+ end
811
930
 
812
- # Information about an AWS service returned by the DescribeServices
813
- # operation.
814
- # @!attribute [rw] code
815
- # The code for an AWS service returned by the DescribeServices
816
- # response. The `name` element contains the corresponding friendly
817
- # name.
818
- # @return [String]
819
- #
820
- # @!attribute [rw] name
821
- # The friendly name for an AWS service. The `code` element contains
822
- # the corresponding code.
823
- # @return [String]
824
- #
825
- # @!attribute [rw] categories
826
- # A list of categories that describe the type of support issue a case
827
- # describes. Categories consist of a category name and a category
828
- # code. Category names and codes are passed to AWS Support when you
829
- # call CreateCase.
830
- # @return [Array<Types::Category>]
831
- class Service < Struct.new(
832
- :code,
833
- :name,
834
- :categories)
835
- include Aws::Structure
836
- end
931
+ # The status of the case returned by the ResolveCase operation.
932
+ #
933
+ # @!attribute [rw] initial_case_status
934
+ # The status of the case when the ResolveCase request was sent.
935
+ # @return [String]
936
+ #
937
+ # @!attribute [rw] final_case_status
938
+ # The status of the case after the ResolveCase request was processed.
939
+ # @return [String]
940
+ #
941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCaseResponse AWS API Documentation
942
+ #
943
+ class ResolveCaseResponse < Struct.new(
944
+ :initial_case_status,
945
+ :final_case_status)
946
+ include Aws::Structure
947
+ end
837
948
 
838
- # A code and name pair that represent a severity level that can be
839
- # applied to a support case.
840
- # @!attribute [rw] code
841
- # One of four values: "low," "medium," "high," and "urgent".
842
- # These values correspond to response times returned to the caller in
843
- # `severityLevel.name`.
844
- # @return [String]
845
- #
846
- # @!attribute [rw] name
847
- # The name of the severity level that corresponds to the severity
848
- # level code.
849
- # @return [String]
850
- class SeverityLevel < Struct.new(
851
- :code,
852
- :name)
853
- include Aws::Structure
854
- end
949
+ # Information about an AWS service returned by the DescribeServices
950
+ # operation.
951
+ #
952
+ # @!attribute [rw] code
953
+ # The code for an AWS service returned by the DescribeServices
954
+ # response. The `name` element contains the corresponding friendly
955
+ # name.
956
+ # @return [String]
957
+ #
958
+ # @!attribute [rw] name
959
+ # The friendly name for an AWS service. The `code` element contains
960
+ # the corresponding code.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] categories
964
+ # A list of categories that describe the type of support issue a case
965
+ # describes. Categories consist of a category name and a category
966
+ # code. Category names and codes are passed to AWS Support when you
967
+ # call CreateCase.
968
+ # @return [Array<Types::Category>]
969
+ #
970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Service AWS API Documentation
971
+ #
972
+ class Service < Struct.new(
973
+ :code,
974
+ :name,
975
+ :categories)
976
+ include Aws::Structure
977
+ end
855
978
 
856
- # The container for summary information that relates to the category of
857
- # the Trusted Advisor check.
858
- # @!attribute [rw] cost_optimizing
859
- # The summary information about cost savings for a Trusted Advisor
860
- # check that is in the Cost Optimizing category.
861
- # @return [Types::TrustedAdvisorCostOptimizingSummary]
862
- class TrustedAdvisorCategorySpecificSummary < Struct.new(
863
- :cost_optimizing)
864
- include Aws::Structure
865
- end
979
+ # A code and name pair that represent a severity level that can be
980
+ # applied to a support case.
981
+ #
982
+ # @!attribute [rw] code
983
+ # One of four values: "low," "medium," "high," and "urgent".
984
+ # These values correspond to response times returned to the caller in
985
+ # `severityLevel.name`.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] name
989
+ # The name of the severity level that corresponds to the severity
990
+ # level code.
991
+ # @return [String]
992
+ #
993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/SeverityLevel AWS API Documentation
994
+ #
995
+ class SeverityLevel < Struct.new(
996
+ :code,
997
+ :name)
998
+ include Aws::Structure
999
+ end
866
1000
 
867
- # The description and metadata for a Trusted Advisor check.
868
- # @!attribute [rw] id
869
- # The unique identifier for the Trusted Advisor check.
870
- # @return [String]
871
- #
872
- # @!attribute [rw] name
873
- # The display name for the Trusted Advisor check.
874
- # @return [String]
875
- #
876
- # @!attribute [rw] description
877
- # The description of the Trusted Advisor check, which includes the
878
- # alert criteria and recommended actions (contains HTML markup).
879
- # @return [String]
880
- #
881
- # @!attribute [rw] category
882
- # The category of the Trusted Advisor check.
883
- # @return [String]
884
- #
885
- # @!attribute [rw] metadata
886
- # The column headings for the data returned by the Trusted Advisor
887
- # check. The order of the headings corresponds to the order of the
888
- # data in the **Metadata** element of the TrustedAdvisorResourceDetail
889
- # for the check. **Metadata** contains all the data that is shown in
890
- # the Excel download, even in those cases where the UI shows just
891
- # summary data.
892
- # @return [Array<String>]
893
- class TrustedAdvisorCheckDescription < Struct.new(
894
- :id,
895
- :name,
896
- :description,
897
- :category,
898
- :metadata)
899
- include Aws::Structure
900
- end
1001
+ # The container for summary information that relates to the category of
1002
+ # the Trusted Advisor check.
1003
+ #
1004
+ # @!attribute [rw] cost_optimizing
1005
+ # The summary information about cost savings for a Trusted Advisor
1006
+ # check that is in the Cost Optimizing category.
1007
+ # @return [Types::TrustedAdvisorCostOptimizingSummary]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCategorySpecificSummary AWS API Documentation
1010
+ #
1011
+ class TrustedAdvisorCategorySpecificSummary < Struct.new(
1012
+ :cost_optimizing)
1013
+ include Aws::Structure
1014
+ end
901
1015
 
902
- # The refresh status of a Trusted Advisor check.
903
- # @!attribute [rw] check_id
904
- # The unique identifier for the Trusted Advisor check.
905
- # @return [String]
906
- #
907
- # @!attribute [rw] status
908
- # The status of the Trusted Advisor check for which a refresh has been
909
- # requested: "none", "enqueued", "processing", "success", or
910
- # "abandoned".
911
- # @return [String]
912
- #
913
- # @!attribute [rw] millis_until_next_refreshable
914
- # The amount of time, in milliseconds, until the Trusted Advisor check
915
- # is eligible for refresh.
916
- # @return [Integer]
917
- class TrustedAdvisorCheckRefreshStatus < Struct.new(
918
- :check_id,
919
- :status,
920
- :millis_until_next_refreshable)
921
- include Aws::Structure
922
- end
1016
+ # The description and metadata for a Trusted Advisor check.
1017
+ #
1018
+ # @!attribute [rw] id
1019
+ # The unique identifier for the Trusted Advisor check.
1020
+ # @return [String]
1021
+ #
1022
+ # @!attribute [rw] name
1023
+ # The display name for the Trusted Advisor check.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] description
1027
+ # The description of the Trusted Advisor check, which includes the
1028
+ # alert criteria and recommended actions (contains HTML markup).
1029
+ # @return [String]
1030
+ #
1031
+ # @!attribute [rw] category
1032
+ # The category of the Trusted Advisor check.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] metadata
1036
+ # The column headings for the data returned by the Trusted Advisor
1037
+ # check. The order of the headings corresponds to the order of the
1038
+ # data in the **Metadata** element of the TrustedAdvisorResourceDetail
1039
+ # for the check. **Metadata** contains all the data that is shown in
1040
+ # the Excel download, even in those cases where the UI shows just
1041
+ # summary data.
1042
+ # @return [Array<String>]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckDescription AWS API Documentation
1045
+ #
1046
+ class TrustedAdvisorCheckDescription < Struct.new(
1047
+ :id,
1048
+ :name,
1049
+ :description,
1050
+ :category,
1051
+ :metadata)
1052
+ include Aws::Structure
1053
+ end
923
1054
 
924
- # The results of a Trusted Advisor check returned by
925
- # DescribeTrustedAdvisorCheckResult.
926
- # @!attribute [rw] check_id
927
- # The unique identifier for the Trusted Advisor check.
928
- # @return [String]
929
- #
930
- # @!attribute [rw] timestamp
931
- # The time of the last refresh of the check.
932
- # @return [String]
933
- #
934
- # @!attribute [rw] status
935
- # The alert status of the check: "ok" (green), "warning" (yellow),
936
- # "error" (red), or "not\_available".
937
- # @return [String]
938
- #
939
- # @!attribute [rw] resources_summary
940
- # Details about AWS resources that were analyzed in a call to Trusted
941
- # Advisor DescribeTrustedAdvisorCheckSummaries.
942
- # @return [Types::TrustedAdvisorResourcesSummary]
943
- #
944
- # @!attribute [rw] category_specific_summary
945
- # Summary information that relates to the category of the check. Cost
946
- # Optimizing is the only category that is currently supported.
947
- # @return [Types::TrustedAdvisorCategorySpecificSummary]
948
- #
949
- # @!attribute [rw] flagged_resources
950
- # The details about each resource listed in the check result.
951
- # @return [Array<Types::TrustedAdvisorResourceDetail>]
952
- class TrustedAdvisorCheckResult < Struct.new(
953
- :check_id,
954
- :timestamp,
955
- :status,
956
- :resources_summary,
957
- :category_specific_summary,
958
- :flagged_resources)
959
- include Aws::Structure
960
- end
1055
+ # The refresh status of a Trusted Advisor check.
1056
+ #
1057
+ # @!attribute [rw] check_id
1058
+ # The unique identifier for the Trusted Advisor check.
1059
+ # @return [String]
1060
+ #
1061
+ # @!attribute [rw] status
1062
+ # The status of the Trusted Advisor check for which a refresh has been
1063
+ # requested: "none", "enqueued", "processing", "success", or
1064
+ # "abandoned".
1065
+ # @return [String]
1066
+ #
1067
+ # @!attribute [rw] millis_until_next_refreshable
1068
+ # The amount of time, in milliseconds, until the Trusted Advisor check
1069
+ # is eligible for refresh.
1070
+ # @return [Integer]
1071
+ #
1072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckRefreshStatus AWS API Documentation
1073
+ #
1074
+ class TrustedAdvisorCheckRefreshStatus < Struct.new(
1075
+ :check_id,
1076
+ :status,
1077
+ :millis_until_next_refreshable)
1078
+ include Aws::Structure
1079
+ end
961
1080
 
962
- # A summary of a Trusted Advisor check result, including the alert
963
- # status, last refresh, and number of resources examined.
964
- # @!attribute [rw] check_id
965
- # The unique identifier for the Trusted Advisor check.
966
- # @return [String]
967
- #
968
- # @!attribute [rw] timestamp
969
- # The time of the last refresh of the check.
970
- # @return [String]
971
- #
972
- # @!attribute [rw] status
973
- # The alert status of the check: "ok" (green), "warning" (yellow),
974
- # "error" (red), or "not\_available".
975
- # @return [String]
976
- #
977
- # @!attribute [rw] has_flagged_resources
978
- # Specifies whether the Trusted Advisor check has flagged resources.
979
- # @return [Boolean]
980
- #
981
- # @!attribute [rw] resources_summary
982
- # Details about AWS resources that were analyzed in a call to Trusted
983
- # Advisor DescribeTrustedAdvisorCheckSummaries.
984
- # @return [Types::TrustedAdvisorResourcesSummary]
985
- #
986
- # @!attribute [rw] category_specific_summary
987
- # Summary information that relates to the category of the check. Cost
988
- # Optimizing is the only category that is currently supported.
989
- # @return [Types::TrustedAdvisorCategorySpecificSummary]
990
- class TrustedAdvisorCheckSummary < Struct.new(
991
- :check_id,
992
- :timestamp,
993
- :status,
994
- :has_flagged_resources,
995
- :resources_summary,
996
- :category_specific_summary)
997
- include Aws::Structure
998
- end
1081
+ # The results of a Trusted Advisor check returned by
1082
+ # DescribeTrustedAdvisorCheckResult.
1083
+ #
1084
+ # @!attribute [rw] check_id
1085
+ # The unique identifier for the Trusted Advisor check.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] timestamp
1089
+ # The time of the last refresh of the check.
1090
+ # @return [String]
1091
+ #
1092
+ # @!attribute [rw] status
1093
+ # The alert status of the check: "ok" (green), "warning" (yellow),
1094
+ # "error" (red), or "not\_available".
1095
+ # @return [String]
1096
+ #
1097
+ # @!attribute [rw] resources_summary
1098
+ # Details about AWS resources that were analyzed in a call to Trusted
1099
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
1100
+ # @return [Types::TrustedAdvisorResourcesSummary]
1101
+ #
1102
+ # @!attribute [rw] category_specific_summary
1103
+ # Summary information that relates to the category of the check. Cost
1104
+ # Optimizing is the only category that is currently supported.
1105
+ # @return [Types::TrustedAdvisorCategorySpecificSummary]
1106
+ #
1107
+ # @!attribute [rw] flagged_resources
1108
+ # The details about each resource listed in the check result.
1109
+ # @return [Array<Types::TrustedAdvisorResourceDetail>]
1110
+ #
1111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckResult AWS API Documentation
1112
+ #
1113
+ class TrustedAdvisorCheckResult < Struct.new(
1114
+ :check_id,
1115
+ :timestamp,
1116
+ :status,
1117
+ :resources_summary,
1118
+ :category_specific_summary,
1119
+ :flagged_resources)
1120
+ include Aws::Structure
1121
+ end
999
1122
 
1000
- # The estimated cost savings that might be realized if the recommended
1001
- # actions are taken.
1002
- # @!attribute [rw] estimated_monthly_savings
1003
- # The estimated monthly savings that might be realized if the
1004
- # recommended actions are taken.
1005
- # @return [Float]
1006
- #
1007
- # @!attribute [rw] estimated_percent_monthly_savings
1008
- # The estimated percentage of savings that might be realized if the
1009
- # recommended actions are taken.
1010
- # @return [Float]
1011
- class TrustedAdvisorCostOptimizingSummary < Struct.new(
1012
- :estimated_monthly_savings,
1013
- :estimated_percent_monthly_savings)
1014
- include Aws::Structure
1015
- end
1123
+ # A summary of a Trusted Advisor check result, including the alert
1124
+ # status, last refresh, and number of resources examined.
1125
+ #
1126
+ # @!attribute [rw] check_id
1127
+ # The unique identifier for the Trusted Advisor check.
1128
+ # @return [String]
1129
+ #
1130
+ # @!attribute [rw] timestamp
1131
+ # The time of the last refresh of the check.
1132
+ # @return [String]
1133
+ #
1134
+ # @!attribute [rw] status
1135
+ # The alert status of the check: "ok" (green), "warning" (yellow),
1136
+ # "error" (red), or "not\_available".
1137
+ # @return [String]
1138
+ #
1139
+ # @!attribute [rw] has_flagged_resources
1140
+ # Specifies whether the Trusted Advisor check has flagged resources.
1141
+ # @return [Boolean]
1142
+ #
1143
+ # @!attribute [rw] resources_summary
1144
+ # Details about AWS resources that were analyzed in a call to Trusted
1145
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
1146
+ # @return [Types::TrustedAdvisorResourcesSummary]
1147
+ #
1148
+ # @!attribute [rw] category_specific_summary
1149
+ # Summary information that relates to the category of the check. Cost
1150
+ # Optimizing is the only category that is currently supported.
1151
+ # @return [Types::TrustedAdvisorCategorySpecificSummary]
1152
+ #
1153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckSummary AWS API Documentation
1154
+ #
1155
+ class TrustedAdvisorCheckSummary < Struct.new(
1156
+ :check_id,
1157
+ :timestamp,
1158
+ :status,
1159
+ :has_flagged_resources,
1160
+ :resources_summary,
1161
+ :category_specific_summary)
1162
+ include Aws::Structure
1163
+ end
1016
1164
 
1017
- # Contains information about a resource identified by a Trusted Advisor
1018
- # check.
1019
- # @!attribute [rw] status
1020
- # The status code for the resource identified in the Trusted Advisor
1021
- # check.
1022
- # @return [String]
1023
- #
1024
- # @!attribute [rw] region
1025
- # The AWS region in which the identified resource is located.
1026
- # @return [String]
1027
- #
1028
- # @!attribute [rw] resource_id
1029
- # The unique identifier for the identified resource.
1030
- # @return [String]
1031
- #
1032
- # @!attribute [rw] is_suppressed
1033
- # Specifies whether the AWS resource was ignored by Trusted Advisor
1034
- # because it was marked as suppressed by the user.
1035
- # @return [Boolean]
1036
- #
1037
- # @!attribute [rw] metadata
1038
- # Additional information about the identified resource. The exact
1039
- # metadata and its order can be obtained by inspecting the
1040
- # TrustedAdvisorCheckDescription object returned by the call to
1041
- # DescribeTrustedAdvisorChecks. **Metadata** contains all the data
1042
- # that is shown in the Excel download, even in those cases where the
1043
- # UI shows just summary data.
1044
- # @return [Array<String>]
1045
- class TrustedAdvisorResourceDetail < Struct.new(
1046
- :status,
1047
- :region,
1048
- :resource_id,
1049
- :is_suppressed,
1050
- :metadata)
1051
- include Aws::Structure
1052
- end
1165
+ # The estimated cost savings that might be realized if the recommended
1166
+ # actions are taken.
1167
+ #
1168
+ # @!attribute [rw] estimated_monthly_savings
1169
+ # The estimated monthly savings that might be realized if the
1170
+ # recommended actions are taken.
1171
+ # @return [Float]
1172
+ #
1173
+ # @!attribute [rw] estimated_percent_monthly_savings
1174
+ # The estimated percentage of savings that might be realized if the
1175
+ # recommended actions are taken.
1176
+ # @return [Float]
1177
+ #
1178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCostOptimizingSummary AWS API Documentation
1179
+ #
1180
+ class TrustedAdvisorCostOptimizingSummary < Struct.new(
1181
+ :estimated_monthly_savings,
1182
+ :estimated_percent_monthly_savings)
1183
+ include Aws::Structure
1184
+ end
1053
1185
 
1054
- # Details about AWS resources that were analyzed in a call to Trusted
1055
- # Advisor DescribeTrustedAdvisorCheckSummaries.
1056
- # @!attribute [rw] resources_processed
1057
- # The number of AWS resources that were analyzed by the Trusted
1058
- # Advisor check.
1059
- # @return [Integer]
1060
- #
1061
- # @!attribute [rw] resources_flagged
1062
- # The number of AWS resources that were flagged (listed) by the
1063
- # Trusted Advisor check.
1064
- # @return [Integer]
1065
- #
1066
- # @!attribute [rw] resources_ignored
1067
- # The number of AWS resources ignored by Trusted Advisor because
1068
- # information was unavailable.
1069
- # @return [Integer]
1070
- #
1071
- # @!attribute [rw] resources_suppressed
1072
- # The number of AWS resources ignored by Trusted Advisor because they
1073
- # were marked as suppressed by the user.
1074
- # @return [Integer]
1075
- class TrustedAdvisorResourcesSummary < Struct.new(
1076
- :resources_processed,
1077
- :resources_flagged,
1078
- :resources_ignored,
1079
- :resources_suppressed)
1080
- include Aws::Structure
1081
- end
1186
+ # Contains information about a resource identified by a Trusted Advisor
1187
+ # check.
1188
+ #
1189
+ # @!attribute [rw] status
1190
+ # The status code for the resource identified in the Trusted Advisor
1191
+ # check.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] region
1195
+ # The AWS region in which the identified resource is located.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] resource_id
1199
+ # The unique identifier for the identified resource.
1200
+ # @return [String]
1201
+ #
1202
+ # @!attribute [rw] is_suppressed
1203
+ # Specifies whether the AWS resource was ignored by Trusted Advisor
1204
+ # because it was marked as suppressed by the user.
1205
+ # @return [Boolean]
1206
+ #
1207
+ # @!attribute [rw] metadata
1208
+ # Additional information about the identified resource. The exact
1209
+ # metadata and its order can be obtained by inspecting the
1210
+ # TrustedAdvisorCheckDescription object returned by the call to
1211
+ # DescribeTrustedAdvisorChecks. **Metadata** contains all the data
1212
+ # that is shown in the Excel download, even in those cases where the
1213
+ # UI shows just summary data.
1214
+ # @return [Array<String>]
1215
+ #
1216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorResourceDetail AWS API Documentation
1217
+ #
1218
+ class TrustedAdvisorResourceDetail < Struct.new(
1219
+ :status,
1220
+ :region,
1221
+ :resource_id,
1222
+ :is_suppressed,
1223
+ :metadata)
1224
+ include Aws::Structure
1225
+ end
1082
1226
 
1227
+ # Details about AWS resources that were analyzed in a call to Trusted
1228
+ # Advisor DescribeTrustedAdvisorCheckSummaries.
1229
+ #
1230
+ # @!attribute [rw] resources_processed
1231
+ # The number of AWS resources that were analyzed by the Trusted
1232
+ # Advisor check.
1233
+ # @return [Integer]
1234
+ #
1235
+ # @!attribute [rw] resources_flagged
1236
+ # The number of AWS resources that were flagged (listed) by the
1237
+ # Trusted Advisor check.
1238
+ # @return [Integer]
1239
+ #
1240
+ # @!attribute [rw] resources_ignored
1241
+ # The number of AWS resources ignored by Trusted Advisor because
1242
+ # information was unavailable.
1243
+ # @return [Integer]
1244
+ #
1245
+ # @!attribute [rw] resources_suppressed
1246
+ # The number of AWS resources ignored by Trusted Advisor because they
1247
+ # were marked as suppressed by the user.
1248
+ # @return [Integer]
1249
+ #
1250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorResourcesSummary AWS API Documentation
1251
+ #
1252
+ class TrustedAdvisorResourcesSummary < Struct.new(
1253
+ :resources_processed,
1254
+ :resources_flagged,
1255
+ :resources_ignored,
1256
+ :resources_suppressed)
1257
+ include Aws::Structure
1083
1258
  end
1259
+
1084
1260
  end
1085
1261
  end