aws-sdk-wellarchitected 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-wellarchitected.rb +53 -0
- data/lib/aws-sdk-wellarchitected/client.rb +2083 -0
- data/lib/aws-sdk-wellarchitected/client_api.rb +1160 -0
- data/lib/aws-sdk-wellarchitected/customizations.rb +0 -0
- data/lib/aws-sdk-wellarchitected/errors.rb +210 -0
- data/lib/aws-sdk-wellarchitected/resource.rb +26 -0
- data/lib/aws-sdk-wellarchitected/types.rb +3041 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,210 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::WellArchitected
|
11
|
+
|
12
|
+
# When WellArchitected returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::WellArchitected::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all WellArchitected errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::WellArchitected::Errors::ServiceError
|
20
|
+
# # rescues all WellArchitected API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {ConflictException}
|
32
|
+
# * {InternalServerException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ServiceQuotaExceededException}
|
35
|
+
# * {ThrottlingException}
|
36
|
+
# * {ValidationException}
|
37
|
+
#
|
38
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
39
|
+
# if they are not defined above.
|
40
|
+
module Errors
|
41
|
+
|
42
|
+
extend Aws::Errors::DynamicErrors
|
43
|
+
|
44
|
+
class AccessDeniedException < ServiceError
|
45
|
+
|
46
|
+
# @param [Seahorse::Client::RequestContext] context
|
47
|
+
# @param [String] message
|
48
|
+
# @param [Aws::WellArchitected::Types::AccessDeniedException] data
|
49
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
50
|
+
super(context, message, data)
|
51
|
+
end
|
52
|
+
|
53
|
+
# @return [String]
|
54
|
+
def message
|
55
|
+
@message || @data[:message]
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
class ConflictException < ServiceError
|
60
|
+
|
61
|
+
# @param [Seahorse::Client::RequestContext] context
|
62
|
+
# @param [String] message
|
63
|
+
# @param [Aws::WellArchitected::Types::ConflictException] data
|
64
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
65
|
+
super(context, message, data)
|
66
|
+
end
|
67
|
+
|
68
|
+
# @return [String]
|
69
|
+
def message
|
70
|
+
@message || @data[:message]
|
71
|
+
end
|
72
|
+
|
73
|
+
# @return [String]
|
74
|
+
def resource_id
|
75
|
+
@data[:resource_id]
|
76
|
+
end
|
77
|
+
|
78
|
+
# @return [String]
|
79
|
+
def resource_type
|
80
|
+
@data[:resource_type]
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
class InternalServerException < ServiceError
|
85
|
+
|
86
|
+
# @param [Seahorse::Client::RequestContext] context
|
87
|
+
# @param [String] message
|
88
|
+
# @param [Aws::WellArchitected::Types::InternalServerException] data
|
89
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
90
|
+
super(context, message, data)
|
91
|
+
end
|
92
|
+
|
93
|
+
# @return [String]
|
94
|
+
def message
|
95
|
+
@message || @data[:message]
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
class ResourceNotFoundException < ServiceError
|
100
|
+
|
101
|
+
# @param [Seahorse::Client::RequestContext] context
|
102
|
+
# @param [String] message
|
103
|
+
# @param [Aws::WellArchitected::Types::ResourceNotFoundException] data
|
104
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
105
|
+
super(context, message, data)
|
106
|
+
end
|
107
|
+
|
108
|
+
# @return [String]
|
109
|
+
def message
|
110
|
+
@message || @data[:message]
|
111
|
+
end
|
112
|
+
|
113
|
+
# @return [String]
|
114
|
+
def resource_id
|
115
|
+
@data[:resource_id]
|
116
|
+
end
|
117
|
+
|
118
|
+
# @return [String]
|
119
|
+
def resource_type
|
120
|
+
@data[:resource_type]
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
class ServiceQuotaExceededException < ServiceError
|
125
|
+
|
126
|
+
# @param [Seahorse::Client::RequestContext] context
|
127
|
+
# @param [String] message
|
128
|
+
# @param [Aws::WellArchitected::Types::ServiceQuotaExceededException] data
|
129
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
130
|
+
super(context, message, data)
|
131
|
+
end
|
132
|
+
|
133
|
+
# @return [String]
|
134
|
+
def message
|
135
|
+
@message || @data[:message]
|
136
|
+
end
|
137
|
+
|
138
|
+
# @return [String]
|
139
|
+
def resource_id
|
140
|
+
@data[:resource_id]
|
141
|
+
end
|
142
|
+
|
143
|
+
# @return [String]
|
144
|
+
def resource_type
|
145
|
+
@data[:resource_type]
|
146
|
+
end
|
147
|
+
|
148
|
+
# @return [String]
|
149
|
+
def quota_code
|
150
|
+
@data[:quota_code]
|
151
|
+
end
|
152
|
+
|
153
|
+
# @return [String]
|
154
|
+
def service_code
|
155
|
+
@data[:service_code]
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
class ThrottlingException < ServiceError
|
160
|
+
|
161
|
+
# @param [Seahorse::Client::RequestContext] context
|
162
|
+
# @param [String] message
|
163
|
+
# @param [Aws::WellArchitected::Types::ThrottlingException] data
|
164
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
165
|
+
super(context, message, data)
|
166
|
+
end
|
167
|
+
|
168
|
+
# @return [String]
|
169
|
+
def message
|
170
|
+
@message || @data[:message]
|
171
|
+
end
|
172
|
+
|
173
|
+
# @return [String]
|
174
|
+
def quota_code
|
175
|
+
@data[:quota_code]
|
176
|
+
end
|
177
|
+
|
178
|
+
# @return [String]
|
179
|
+
def service_code
|
180
|
+
@data[:service_code]
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
class ValidationException < ServiceError
|
185
|
+
|
186
|
+
# @param [Seahorse::Client::RequestContext] context
|
187
|
+
# @param [String] message
|
188
|
+
# @param [Aws::WellArchitected::Types::ValidationException] data
|
189
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
190
|
+
super(context, message, data)
|
191
|
+
end
|
192
|
+
|
193
|
+
# @return [String]
|
194
|
+
def message
|
195
|
+
@message || @data[:message]
|
196
|
+
end
|
197
|
+
|
198
|
+
# @return [String]
|
199
|
+
def reason
|
200
|
+
@data[:reason]
|
201
|
+
end
|
202
|
+
|
203
|
+
# @return [String]
|
204
|
+
def fields
|
205
|
+
@data[:fields]
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
end
|
210
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::WellArchitected
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,3041 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::WellArchitected
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# User does not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# Description of the error.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AccessDeniedException AWS API Documentation
|
20
|
+
#
|
21
|
+
class AccessDeniedException < Struct.new(
|
22
|
+
:message)
|
23
|
+
SENSITIVE = []
|
24
|
+
include Aws::Structure
|
25
|
+
end
|
26
|
+
|
27
|
+
# An answer of the question.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] question_id
|
30
|
+
# The ID of the question.
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] pillar_id
|
34
|
+
# The ID used to identify a pillar, for example, `security`.
|
35
|
+
#
|
36
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] question_title
|
40
|
+
# The title of the question.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] question_description
|
44
|
+
# The description of the question.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] improvement_plan_url
|
48
|
+
# The improvement plan URL for a question.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] helpful_resource_url
|
52
|
+
# The helpful resource URL for a question.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] choices
|
56
|
+
# List of choices available for a question.
|
57
|
+
# @return [Array<Types::Choice>]
|
58
|
+
#
|
59
|
+
# @!attribute [rw] selected_choices
|
60
|
+
# List of selected choice IDs in a question answer.
|
61
|
+
# @return [Array<String>]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] is_applicable
|
64
|
+
# Defines whether this question is applicable to a lens review.
|
65
|
+
# @return [Boolean]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] risk
|
68
|
+
# The risk for a given workload, lens review, pillar, or question.
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] notes
|
72
|
+
# The notes associated with the workload.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Answer AWS API Documentation
|
76
|
+
#
|
77
|
+
class Answer < Struct.new(
|
78
|
+
:question_id,
|
79
|
+
:pillar_id,
|
80
|
+
:question_title,
|
81
|
+
:question_description,
|
82
|
+
:improvement_plan_url,
|
83
|
+
:helpful_resource_url,
|
84
|
+
:choices,
|
85
|
+
:selected_choices,
|
86
|
+
:is_applicable,
|
87
|
+
:risk,
|
88
|
+
:notes)
|
89
|
+
SENSITIVE = []
|
90
|
+
include Aws::Structure
|
91
|
+
end
|
92
|
+
|
93
|
+
# An answer summary of a lens review in a workload.
|
94
|
+
#
|
95
|
+
# @!attribute [rw] question_id
|
96
|
+
# The ID of the question.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] pillar_id
|
100
|
+
# The ID used to identify a pillar, for example, `security`.
|
101
|
+
#
|
102
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] question_title
|
106
|
+
# The title of the question.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] choices
|
110
|
+
# List of choices available for a question.
|
111
|
+
# @return [Array<Types::Choice>]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] selected_choices
|
114
|
+
# List of selected choice IDs in a question answer.
|
115
|
+
# @return [Array<String>]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] is_applicable
|
118
|
+
# Defines whether this question is applicable to a lens review.
|
119
|
+
# @return [Boolean]
|
120
|
+
#
|
121
|
+
# @!attribute [rw] risk
|
122
|
+
# The risk for a given workload, lens review, pillar, or question.
|
123
|
+
# @return [String]
|
124
|
+
#
|
125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AnswerSummary AWS API Documentation
|
126
|
+
#
|
127
|
+
class AnswerSummary < Struct.new(
|
128
|
+
:question_id,
|
129
|
+
:pillar_id,
|
130
|
+
:question_title,
|
131
|
+
:choices,
|
132
|
+
:selected_choices,
|
133
|
+
:is_applicable,
|
134
|
+
:risk)
|
135
|
+
SENSITIVE = []
|
136
|
+
include Aws::Structure
|
137
|
+
end
|
138
|
+
|
139
|
+
# Input to associate lens reviews.
|
140
|
+
#
|
141
|
+
# @note When making an API call, you may pass AssociateLensesInput
|
142
|
+
# data as a hash:
|
143
|
+
#
|
144
|
+
# {
|
145
|
+
# workload_id: "WorkloadId", # required
|
146
|
+
# lens_aliases: ["LensAlias"], # required
|
147
|
+
# }
|
148
|
+
#
|
149
|
+
# @!attribute [rw] workload_id
|
150
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
151
|
+
# Region.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] lens_aliases
|
155
|
+
# List of lens aliases to associate or disassociate with a workload.
|
156
|
+
#
|
157
|
+
# Identify a lens using its LensSummary$LensAlias.
|
158
|
+
# @return [Array<String>]
|
159
|
+
#
|
160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateLensesInput AWS API Documentation
|
161
|
+
#
|
162
|
+
class AssociateLensesInput < Struct.new(
|
163
|
+
:workload_id,
|
164
|
+
:lens_aliases)
|
165
|
+
SENSITIVE = []
|
166
|
+
include Aws::Structure
|
167
|
+
end
|
168
|
+
|
169
|
+
# A choice available to answer question.
|
170
|
+
#
|
171
|
+
# @!attribute [rw] choice_id
|
172
|
+
# The ID of a choice.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] title
|
176
|
+
# The title of a choice.
|
177
|
+
# @return [String]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] description
|
180
|
+
# The description of a choice.
|
181
|
+
# @return [String]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Choice AWS API Documentation
|
184
|
+
#
|
185
|
+
class Choice < Struct.new(
|
186
|
+
:choice_id,
|
187
|
+
:title,
|
188
|
+
:description)
|
189
|
+
SENSITIVE = []
|
190
|
+
include Aws::Structure
|
191
|
+
end
|
192
|
+
|
193
|
+
# The resource already exists.
|
194
|
+
#
|
195
|
+
# @!attribute [rw] message
|
196
|
+
# Description of the error.
|
197
|
+
# @return [String]
|
198
|
+
#
|
199
|
+
# @!attribute [rw] resource_id
|
200
|
+
# Identifier of the resource affected.
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] resource_type
|
204
|
+
# Type of the resource affected.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ConflictException AWS API Documentation
|
208
|
+
#
|
209
|
+
class ConflictException < Struct.new(
|
210
|
+
:message,
|
211
|
+
:resource_id,
|
212
|
+
:resource_type)
|
213
|
+
SENSITIVE = []
|
214
|
+
include Aws::Structure
|
215
|
+
end
|
216
|
+
|
217
|
+
# Input for milestone creation.
|
218
|
+
#
|
219
|
+
# @note When making an API call, you may pass CreateMilestoneInput
|
220
|
+
# data as a hash:
|
221
|
+
#
|
222
|
+
# {
|
223
|
+
# workload_id: "WorkloadId", # required
|
224
|
+
# milestone_name: "MilestoneName", # required
|
225
|
+
# client_request_token: "ClientRequestToken", # required
|
226
|
+
# }
|
227
|
+
#
|
228
|
+
# @!attribute [rw] workload_id
|
229
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
230
|
+
# Region.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] milestone_name
|
234
|
+
# The name of the milestone in a workload.
|
235
|
+
#
|
236
|
+
# Milestone names must be unique within a workload.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] client_request_token
|
240
|
+
# A unique case-sensitive string used to ensure that this request is
|
241
|
+
# idempotent (executes only once).
|
242
|
+
#
|
243
|
+
# You should not reuse the same token for other requests. If you retry
|
244
|
+
# a request with the same client request token and the same parameters
|
245
|
+
# after it has completed successfully, the result of the original
|
246
|
+
# request is returned.
|
247
|
+
#
|
248
|
+
# This token is listed as required, however, if you do not specify it,
|
249
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
250
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
251
|
+
# request will fail.
|
252
|
+
#
|
253
|
+
# **A suitable default value is auto-generated.** You should normally
|
254
|
+
# not need to pass this option.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateMilestoneInput AWS API Documentation
|
258
|
+
#
|
259
|
+
class CreateMilestoneInput < Struct.new(
|
260
|
+
:workload_id,
|
261
|
+
:milestone_name,
|
262
|
+
:client_request_token)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# Output of a create milestone call.
|
268
|
+
#
|
269
|
+
# @!attribute [rw] workload_id
|
270
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
271
|
+
# Region.
|
272
|
+
# @return [String]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] milestone_number
|
275
|
+
# The milestone number.
|
276
|
+
#
|
277
|
+
# A workload can have a maximum of 100 milestones.
|
278
|
+
# @return [Integer]
|
279
|
+
#
|
280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateMilestoneOutput AWS API Documentation
|
281
|
+
#
|
282
|
+
class CreateMilestoneOutput < Struct.new(
|
283
|
+
:workload_id,
|
284
|
+
:milestone_number)
|
285
|
+
SENSITIVE = []
|
286
|
+
include Aws::Structure
|
287
|
+
end
|
288
|
+
|
289
|
+
# Input for workload creation.
|
290
|
+
#
|
291
|
+
# @note When making an API call, you may pass CreateWorkloadInput
|
292
|
+
# data as a hash:
|
293
|
+
#
|
294
|
+
# {
|
295
|
+
# workload_name: "WorkloadName", # required
|
296
|
+
# description: "WorkloadDescription", # required
|
297
|
+
# environment: "PRODUCTION", # required, accepts PRODUCTION, PREPRODUCTION
|
298
|
+
# account_ids: ["AwsAccountId"],
|
299
|
+
# aws_regions: ["AwsRegion"],
|
300
|
+
# non_aws_regions: ["WorkloadNonAwsRegion"],
|
301
|
+
# pillar_priorities: ["PillarId"],
|
302
|
+
# architectural_design: "WorkloadArchitecturalDesign",
|
303
|
+
# review_owner: "WorkloadReviewOwner", # required
|
304
|
+
# industry_type: "WorkloadIndustryType",
|
305
|
+
# industry: "WorkloadIndustry",
|
306
|
+
# lenses: ["LensAlias"], # required
|
307
|
+
# notes: "Notes",
|
308
|
+
# client_request_token: "ClientRequestToken", # required
|
309
|
+
# }
|
310
|
+
#
|
311
|
+
# @!attribute [rw] workload_name
|
312
|
+
# The name of the workload.
|
313
|
+
#
|
314
|
+
# The name must be unique within an account within a Region. Spaces
|
315
|
+
# and capitalization are ignored when checking for uniqueness.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] description
|
319
|
+
# The description for the workload.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] environment
|
323
|
+
# The environment for the workload.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] account_ids
|
327
|
+
# The list of AWS account IDs associated with the workload.
|
328
|
+
# @return [Array<String>]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] aws_regions
|
331
|
+
# The list of AWS Regions associated with the workload, for example,
|
332
|
+
# `us-east-2`, or `ca-central-1`.
|
333
|
+
# @return [Array<String>]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] non_aws_regions
|
336
|
+
# The list of non-AWS Regions associated with the workload.
|
337
|
+
# @return [Array<String>]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] pillar_priorities
|
340
|
+
# The priorities of the pillars, which are used to order items in the
|
341
|
+
# improvement plan. Each pillar is represented by its
|
342
|
+
# PillarReviewSummary$PillarId.
|
343
|
+
# @return [Array<String>]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] architectural_design
|
346
|
+
# The URL of the architectural design for the workload.
|
347
|
+
# @return [String]
|
348
|
+
#
|
349
|
+
# @!attribute [rw] review_owner
|
350
|
+
# The review owner of the workload. The name, email address, or
|
351
|
+
# identifier for the primary group or individual that owns the
|
352
|
+
# workload review process.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] industry_type
|
356
|
+
# The industry type for the workload.
|
357
|
+
#
|
358
|
+
# If specified, must be one of the following:
|
359
|
+
#
|
360
|
+
# * `Agriculture`
|
361
|
+
#
|
362
|
+
# * `Automobile`
|
363
|
+
#
|
364
|
+
# * `Defense`
|
365
|
+
#
|
366
|
+
# * `Design and Engineering`
|
367
|
+
#
|
368
|
+
# * `Digital Advertising`
|
369
|
+
#
|
370
|
+
# * `Education`
|
371
|
+
#
|
372
|
+
# * `Environmental Protection`
|
373
|
+
#
|
374
|
+
# * `Financial Services`
|
375
|
+
#
|
376
|
+
# * `Gaming`
|
377
|
+
#
|
378
|
+
# * `General Public Services`
|
379
|
+
#
|
380
|
+
# * `Healthcare`
|
381
|
+
#
|
382
|
+
# * `Hospitality`
|
383
|
+
#
|
384
|
+
# * `InfoTech`
|
385
|
+
#
|
386
|
+
# * `Justice and Public Safety`
|
387
|
+
#
|
388
|
+
# * `Life Sciences`
|
389
|
+
#
|
390
|
+
# * `Manufacturing`
|
391
|
+
#
|
392
|
+
# * `Media & Entertainment`
|
393
|
+
#
|
394
|
+
# * `Mining & Resources`
|
395
|
+
#
|
396
|
+
# * `Oil & Gas`
|
397
|
+
#
|
398
|
+
# * `Power & Utilities`
|
399
|
+
#
|
400
|
+
# * `Professional Services`
|
401
|
+
#
|
402
|
+
# * `Real Estate & Construction`
|
403
|
+
#
|
404
|
+
# * `Retail & Wholesale`
|
405
|
+
#
|
406
|
+
# * `Social Protection`
|
407
|
+
#
|
408
|
+
# * `Telecommunications`
|
409
|
+
#
|
410
|
+
# * `Travel, Transportation & Logistics`
|
411
|
+
#
|
412
|
+
# * `Other`
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] industry
|
416
|
+
# The industry for the workload.
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] lenses
|
420
|
+
# The list of lenses associated with the workload. Each lens is
|
421
|
+
# identified by its LensSummary$LensAlias.
|
422
|
+
# @return [Array<String>]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] notes
|
425
|
+
# The notes associated with the workload.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] client_request_token
|
429
|
+
# A unique case-sensitive string used to ensure that this request is
|
430
|
+
# idempotent (executes only once).
|
431
|
+
#
|
432
|
+
# You should not reuse the same token for other requests. If you retry
|
433
|
+
# a request with the same client request token and the same parameters
|
434
|
+
# after it has completed successfully, the result of the original
|
435
|
+
# request is returned.
|
436
|
+
#
|
437
|
+
# This token is listed as required, however, if you do not specify it,
|
438
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
439
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
440
|
+
# request will fail.
|
441
|
+
#
|
442
|
+
# **A suitable default value is auto-generated.** You should normally
|
443
|
+
# not need to pass this option.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadInput AWS API Documentation
|
447
|
+
#
|
448
|
+
class CreateWorkloadInput < Struct.new(
|
449
|
+
:workload_name,
|
450
|
+
:description,
|
451
|
+
:environment,
|
452
|
+
:account_ids,
|
453
|
+
:aws_regions,
|
454
|
+
:non_aws_regions,
|
455
|
+
:pillar_priorities,
|
456
|
+
:architectural_design,
|
457
|
+
:review_owner,
|
458
|
+
:industry_type,
|
459
|
+
:industry,
|
460
|
+
:lenses,
|
461
|
+
:notes,
|
462
|
+
:client_request_token)
|
463
|
+
SENSITIVE = []
|
464
|
+
include Aws::Structure
|
465
|
+
end
|
466
|
+
|
467
|
+
# Output of a create workload call.
|
468
|
+
#
|
469
|
+
# @!attribute [rw] workload_id
|
470
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
471
|
+
# Region.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] workload_arn
|
475
|
+
# The ARN for the workload.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadOutput AWS API Documentation
|
479
|
+
#
|
480
|
+
class CreateWorkloadOutput < Struct.new(
|
481
|
+
:workload_id,
|
482
|
+
:workload_arn)
|
483
|
+
SENSITIVE = []
|
484
|
+
include Aws::Structure
|
485
|
+
end
|
486
|
+
|
487
|
+
# Input for Create Workload Share
|
488
|
+
#
|
489
|
+
# @note When making an API call, you may pass CreateWorkloadShareInput
|
490
|
+
# data as a hash:
|
491
|
+
#
|
492
|
+
# {
|
493
|
+
# workload_id: "WorkloadId", # required
|
494
|
+
# shared_with: "SharedWith", # required
|
495
|
+
# permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
|
496
|
+
# client_request_token: "ClientRequestToken", # required
|
497
|
+
# }
|
498
|
+
#
|
499
|
+
# @!attribute [rw] workload_id
|
500
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
501
|
+
# Region.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] shared_with
|
505
|
+
# The AWS account ID or IAM role with which the workload is shared.
|
506
|
+
# @return [String]
|
507
|
+
#
|
508
|
+
# @!attribute [rw] permission_type
|
509
|
+
# Permission granted on a workload share.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] client_request_token
|
513
|
+
# A unique case-sensitive string used to ensure that this request is
|
514
|
+
# idempotent (executes only once).
|
515
|
+
#
|
516
|
+
# You should not reuse the same token for other requests. If you retry
|
517
|
+
# a request with the same client request token and the same parameters
|
518
|
+
# after it has completed successfully, the result of the original
|
519
|
+
# request is returned.
|
520
|
+
#
|
521
|
+
# This token is listed as required, however, if you do not specify it,
|
522
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
523
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
524
|
+
# request will fail.
|
525
|
+
#
|
526
|
+
# **A suitable default value is auto-generated.** You should normally
|
527
|
+
# not need to pass this option.
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShareInput AWS API Documentation
|
531
|
+
#
|
532
|
+
class CreateWorkloadShareInput < Struct.new(
|
533
|
+
:workload_id,
|
534
|
+
:shared_with,
|
535
|
+
:permission_type,
|
536
|
+
:client_request_token)
|
537
|
+
SENSITIVE = []
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
540
|
+
|
541
|
+
# Input for Create Workload Share
|
542
|
+
#
|
543
|
+
# @!attribute [rw] workload_id
|
544
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
545
|
+
# Region.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] share_id
|
549
|
+
# The ID associated with the workload share.
|
550
|
+
# @return [String]
|
551
|
+
#
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShareOutput AWS API Documentation
|
553
|
+
#
|
554
|
+
class CreateWorkloadShareOutput < Struct.new(
|
555
|
+
:workload_id,
|
556
|
+
:share_id)
|
557
|
+
SENSITIVE = []
|
558
|
+
include Aws::Structure
|
559
|
+
end
|
560
|
+
|
561
|
+
# Input for workload deletion.
|
562
|
+
#
|
563
|
+
# @note When making an API call, you may pass DeleteWorkloadInput
|
564
|
+
# data as a hash:
|
565
|
+
#
|
566
|
+
# {
|
567
|
+
# workload_id: "WorkloadId", # required
|
568
|
+
# client_request_token: "ClientRequestToken", # required
|
569
|
+
# }
|
570
|
+
#
|
571
|
+
# @!attribute [rw] workload_id
|
572
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
573
|
+
# Region.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] client_request_token
|
577
|
+
# A unique case-sensitive string used to ensure that this request is
|
578
|
+
# idempotent (executes only once).
|
579
|
+
#
|
580
|
+
# You should not reuse the same token for other requests. If you retry
|
581
|
+
# a request with the same client request token and the same parameters
|
582
|
+
# after it has completed successfully, the result of the original
|
583
|
+
# request is returned.
|
584
|
+
#
|
585
|
+
# This token is listed as required, however, if you do not specify it,
|
586
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
587
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
588
|
+
# request will fail.
|
589
|
+
#
|
590
|
+
# **A suitable default value is auto-generated.** You should normally
|
591
|
+
# not need to pass this option.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkloadInput AWS API Documentation
|
595
|
+
#
|
596
|
+
class DeleteWorkloadInput < Struct.new(
|
597
|
+
:workload_id,
|
598
|
+
:client_request_token)
|
599
|
+
SENSITIVE = []
|
600
|
+
include Aws::Structure
|
601
|
+
end
|
602
|
+
|
603
|
+
# Input for Delete Workload Share
|
604
|
+
#
|
605
|
+
# @note When making an API call, you may pass DeleteWorkloadShareInput
|
606
|
+
# data as a hash:
|
607
|
+
#
|
608
|
+
# {
|
609
|
+
# share_id: "ShareId", # required
|
610
|
+
# workload_id: "WorkloadId", # required
|
611
|
+
# client_request_token: "ClientRequestToken", # required
|
612
|
+
# }
|
613
|
+
#
|
614
|
+
# @!attribute [rw] share_id
|
615
|
+
# The ID associated with the workload share.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] workload_id
|
619
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
620
|
+
# Region.
|
621
|
+
# @return [String]
|
622
|
+
#
|
623
|
+
# @!attribute [rw] client_request_token
|
624
|
+
# A unique case-sensitive string used to ensure that this request is
|
625
|
+
# idempotent (executes only once).
|
626
|
+
#
|
627
|
+
# You should not reuse the same token for other requests. If you retry
|
628
|
+
# a request with the same client request token and the same parameters
|
629
|
+
# after it has completed successfully, the result of the original
|
630
|
+
# request is returned.
|
631
|
+
#
|
632
|
+
# This token is listed as required, however, if you do not specify it,
|
633
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
634
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
635
|
+
# request will fail.
|
636
|
+
#
|
637
|
+
# **A suitable default value is auto-generated.** You should normally
|
638
|
+
# not need to pass this option.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkloadShareInput AWS API Documentation
|
642
|
+
#
|
643
|
+
class DeleteWorkloadShareInput < Struct.new(
|
644
|
+
:share_id,
|
645
|
+
:workload_id,
|
646
|
+
:client_request_token)
|
647
|
+
SENSITIVE = []
|
648
|
+
include Aws::Structure
|
649
|
+
end
|
650
|
+
|
651
|
+
# Input to disassociate lens reviews.
|
652
|
+
#
|
653
|
+
# @note When making an API call, you may pass DisassociateLensesInput
|
654
|
+
# data as a hash:
|
655
|
+
#
|
656
|
+
# {
|
657
|
+
# workload_id: "WorkloadId", # required
|
658
|
+
# lens_aliases: ["LensAlias"], # required
|
659
|
+
# }
|
660
|
+
#
|
661
|
+
# @!attribute [rw] workload_id
|
662
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
663
|
+
# Region.
|
664
|
+
# @return [String]
|
665
|
+
#
|
666
|
+
# @!attribute [rw] lens_aliases
|
667
|
+
# List of lens aliases to associate or disassociate with a workload.
|
668
|
+
#
|
669
|
+
# Identify a lens using its LensSummary$LensAlias.
|
670
|
+
# @return [Array<String>]
|
671
|
+
#
|
672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateLensesInput AWS API Documentation
|
673
|
+
#
|
674
|
+
class DisassociateLensesInput < Struct.new(
|
675
|
+
:workload_id,
|
676
|
+
:lens_aliases)
|
677
|
+
SENSITIVE = []
|
678
|
+
include Aws::Structure
|
679
|
+
end
|
680
|
+
|
681
|
+
# Input to get answer.
|
682
|
+
#
|
683
|
+
# @note When making an API call, you may pass GetAnswerInput
|
684
|
+
# data as a hash:
|
685
|
+
#
|
686
|
+
# {
|
687
|
+
# workload_id: "WorkloadId", # required
|
688
|
+
# lens_alias: "LensAlias", # required
|
689
|
+
# question_id: "QuestionId", # required
|
690
|
+
# milestone_number: 1,
|
691
|
+
# }
|
692
|
+
#
|
693
|
+
# @!attribute [rw] workload_id
|
694
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
695
|
+
# Region.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] lens_alias
|
699
|
+
# The alias of the lens, for example, `serverless`.
|
700
|
+
#
|
701
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] question_id
|
705
|
+
# The ID of the question.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] milestone_number
|
709
|
+
# The milestone number.
|
710
|
+
#
|
711
|
+
# A workload can have a maximum of 100 milestones.
|
712
|
+
# @return [Integer]
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswerInput AWS API Documentation
|
715
|
+
#
|
716
|
+
class GetAnswerInput < Struct.new(
|
717
|
+
:workload_id,
|
718
|
+
:lens_alias,
|
719
|
+
:question_id,
|
720
|
+
:milestone_number)
|
721
|
+
SENSITIVE = []
|
722
|
+
include Aws::Structure
|
723
|
+
end
|
724
|
+
|
725
|
+
# Output of a get answer call.
|
726
|
+
#
|
727
|
+
# @!attribute [rw] workload_id
|
728
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
729
|
+
# Region.
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @!attribute [rw] milestone_number
|
733
|
+
# The milestone number.
|
734
|
+
#
|
735
|
+
# A workload can have a maximum of 100 milestones.
|
736
|
+
# @return [Integer]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] lens_alias
|
739
|
+
# The alias of the lens, for example, `serverless`.
|
740
|
+
#
|
741
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
742
|
+
# @return [String]
|
743
|
+
#
|
744
|
+
# @!attribute [rw] answer
|
745
|
+
# An answer of the question.
|
746
|
+
# @return [Types::Answer]
|
747
|
+
#
|
748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswerOutput AWS API Documentation
|
749
|
+
#
|
750
|
+
class GetAnswerOutput < Struct.new(
|
751
|
+
:workload_id,
|
752
|
+
:milestone_number,
|
753
|
+
:lens_alias,
|
754
|
+
:answer)
|
755
|
+
SENSITIVE = []
|
756
|
+
include Aws::Structure
|
757
|
+
end
|
758
|
+
|
759
|
+
# Input to get lens review.
|
760
|
+
#
|
761
|
+
# @note When making an API call, you may pass GetLensReviewInput
|
762
|
+
# data as a hash:
|
763
|
+
#
|
764
|
+
# {
|
765
|
+
# workload_id: "WorkloadId", # required
|
766
|
+
# lens_alias: "LensAlias", # required
|
767
|
+
# milestone_number: 1,
|
768
|
+
# }
|
769
|
+
#
|
770
|
+
# @!attribute [rw] workload_id
|
771
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
772
|
+
# Region.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] lens_alias
|
776
|
+
# The alias of the lens, for example, `serverless`.
|
777
|
+
#
|
778
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] milestone_number
|
782
|
+
# The milestone number.
|
783
|
+
#
|
784
|
+
# A workload can have a maximum of 100 milestones.
|
785
|
+
# @return [Integer]
|
786
|
+
#
|
787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewInput AWS API Documentation
|
788
|
+
#
|
789
|
+
class GetLensReviewInput < Struct.new(
|
790
|
+
:workload_id,
|
791
|
+
:lens_alias,
|
792
|
+
:milestone_number)
|
793
|
+
SENSITIVE = []
|
794
|
+
include Aws::Structure
|
795
|
+
end
|
796
|
+
|
797
|
+
# Output of a get lens review call.
|
798
|
+
#
|
799
|
+
# @!attribute [rw] workload_id
|
800
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
801
|
+
# Region.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] milestone_number
|
805
|
+
# The milestone number.
|
806
|
+
#
|
807
|
+
# A workload can have a maximum of 100 milestones.
|
808
|
+
# @return [Integer]
|
809
|
+
#
|
810
|
+
# @!attribute [rw] lens_review
|
811
|
+
# A lens review of a question.
|
812
|
+
# @return [Types::LensReview]
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewOutput AWS API Documentation
|
815
|
+
#
|
816
|
+
class GetLensReviewOutput < Struct.new(
|
817
|
+
:workload_id,
|
818
|
+
:milestone_number,
|
819
|
+
:lens_review)
|
820
|
+
SENSITIVE = []
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
824
|
+
# Input to get lens review report.
|
825
|
+
#
|
826
|
+
# @note When making an API call, you may pass GetLensReviewReportInput
|
827
|
+
# data as a hash:
|
828
|
+
#
|
829
|
+
# {
|
830
|
+
# workload_id: "WorkloadId", # required
|
831
|
+
# lens_alias: "LensAlias", # required
|
832
|
+
# milestone_number: 1,
|
833
|
+
# }
|
834
|
+
#
|
835
|
+
# @!attribute [rw] workload_id
|
836
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
837
|
+
# Region.
|
838
|
+
# @return [String]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] lens_alias
|
841
|
+
# The alias of the lens, for example, `serverless`.
|
842
|
+
#
|
843
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
844
|
+
# @return [String]
|
845
|
+
#
|
846
|
+
# @!attribute [rw] milestone_number
|
847
|
+
# The milestone number.
|
848
|
+
#
|
849
|
+
# A workload can have a maximum of 100 milestones.
|
850
|
+
# @return [Integer]
|
851
|
+
#
|
852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReportInput AWS API Documentation
|
853
|
+
#
|
854
|
+
class GetLensReviewReportInput < Struct.new(
|
855
|
+
:workload_id,
|
856
|
+
:lens_alias,
|
857
|
+
:milestone_number)
|
858
|
+
SENSITIVE = []
|
859
|
+
include Aws::Structure
|
860
|
+
end
|
861
|
+
|
862
|
+
# Output of a get lens review report call.
|
863
|
+
#
|
864
|
+
# @!attribute [rw] workload_id
|
865
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
866
|
+
# Region.
|
867
|
+
# @return [String]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] milestone_number
|
870
|
+
# The milestone number.
|
871
|
+
#
|
872
|
+
# A workload can have a maximum of 100 milestones.
|
873
|
+
# @return [Integer]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] lens_review_report
|
876
|
+
# A report of a lens review.
|
877
|
+
# @return [Types::LensReviewReport]
|
878
|
+
#
|
879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReportOutput AWS API Documentation
|
880
|
+
#
|
881
|
+
class GetLensReviewReportOutput < Struct.new(
|
882
|
+
:workload_id,
|
883
|
+
:milestone_number,
|
884
|
+
:lens_review_report)
|
885
|
+
SENSITIVE = []
|
886
|
+
include Aws::Structure
|
887
|
+
end
|
888
|
+
|
889
|
+
# @note When making an API call, you may pass GetLensVersionDifferenceInput
|
890
|
+
# data as a hash:
|
891
|
+
#
|
892
|
+
# {
|
893
|
+
# lens_alias: "LensAlias", # required
|
894
|
+
# base_lens_version: "LensVersion", # required
|
895
|
+
# }
|
896
|
+
#
|
897
|
+
# @!attribute [rw] lens_alias
|
898
|
+
# The alias of the lens, for example, `serverless`.
|
899
|
+
#
|
900
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
901
|
+
# @return [String]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] base_lens_version
|
904
|
+
# The base version of the lens.
|
905
|
+
# @return [String]
|
906
|
+
#
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifferenceInput AWS API Documentation
|
908
|
+
#
|
909
|
+
class GetLensVersionDifferenceInput < Struct.new(
|
910
|
+
:lens_alias,
|
911
|
+
:base_lens_version)
|
912
|
+
SENSITIVE = []
|
913
|
+
include Aws::Structure
|
914
|
+
end
|
915
|
+
|
916
|
+
# @!attribute [rw] lens_alias
|
917
|
+
# The alias of the lens, for example, `serverless`.
|
918
|
+
#
|
919
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] base_lens_version
|
923
|
+
# The base version of the lens.
|
924
|
+
# @return [String]
|
925
|
+
#
|
926
|
+
# @!attribute [rw] latest_lens_version
|
927
|
+
# The latest version of the lens.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] version_differences
|
931
|
+
# The differences between the base and latest versions of the lens.
|
932
|
+
# @return [Types::VersionDifferences]
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifferenceOutput AWS API Documentation
|
935
|
+
#
|
936
|
+
class GetLensVersionDifferenceOutput < Struct.new(
|
937
|
+
:lens_alias,
|
938
|
+
:base_lens_version,
|
939
|
+
:latest_lens_version,
|
940
|
+
:version_differences)
|
941
|
+
SENSITIVE = []
|
942
|
+
include Aws::Structure
|
943
|
+
end
|
944
|
+
|
945
|
+
# Input to get a milestone.
|
946
|
+
#
|
947
|
+
# @note When making an API call, you may pass GetMilestoneInput
|
948
|
+
# data as a hash:
|
949
|
+
#
|
950
|
+
# {
|
951
|
+
# workload_id: "WorkloadId", # required
|
952
|
+
# milestone_number: 1, # required
|
953
|
+
# }
|
954
|
+
#
|
955
|
+
# @!attribute [rw] workload_id
|
956
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
957
|
+
# Region.
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] milestone_number
|
961
|
+
# The milestone number.
|
962
|
+
#
|
963
|
+
# A workload can have a maximum of 100 milestones.
|
964
|
+
# @return [Integer]
|
965
|
+
#
|
966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestoneInput AWS API Documentation
|
967
|
+
#
|
968
|
+
class GetMilestoneInput < Struct.new(
|
969
|
+
:workload_id,
|
970
|
+
:milestone_number)
|
971
|
+
SENSITIVE = []
|
972
|
+
include Aws::Structure
|
973
|
+
end
|
974
|
+
|
975
|
+
# Output of a get milestone call.
|
976
|
+
#
|
977
|
+
# @!attribute [rw] workload_id
|
978
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
979
|
+
# Region.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @!attribute [rw] milestone
|
983
|
+
# A milestone return object.
|
984
|
+
# @return [Types::Milestone]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestoneOutput AWS API Documentation
|
987
|
+
#
|
988
|
+
class GetMilestoneOutput < Struct.new(
|
989
|
+
:workload_id,
|
990
|
+
:milestone)
|
991
|
+
SENSITIVE = []
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# Input to get a workload.
|
996
|
+
#
|
997
|
+
# @note When making an API call, you may pass GetWorkloadInput
|
998
|
+
# data as a hash:
|
999
|
+
#
|
1000
|
+
# {
|
1001
|
+
# workload_id: "WorkloadId", # required
|
1002
|
+
# }
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] workload_id
|
1005
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1006
|
+
# Region.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkloadInput AWS API Documentation
|
1010
|
+
#
|
1011
|
+
class GetWorkloadInput < Struct.new(
|
1012
|
+
:workload_id)
|
1013
|
+
SENSITIVE = []
|
1014
|
+
include Aws::Structure
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# Output of a get workload call.
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] workload
|
1020
|
+
# A workload return object.
|
1021
|
+
# @return [Types::Workload]
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkloadOutput AWS API Documentation
|
1024
|
+
#
|
1025
|
+
class GetWorkloadOutput < Struct.new(
|
1026
|
+
:workload)
|
1027
|
+
SENSITIVE = []
|
1028
|
+
include Aws::Structure
|
1029
|
+
end
|
1030
|
+
|
1031
|
+
# An improvement summary of a lens review in a workload.
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] question_id
|
1034
|
+
# The ID of the question.
|
1035
|
+
# @return [String]
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] pillar_id
|
1038
|
+
# The ID used to identify a pillar, for example, `security`.
|
1039
|
+
#
|
1040
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] question_title
|
1044
|
+
# The title of the question.
|
1045
|
+
# @return [String]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] risk
|
1048
|
+
# The risk for a given workload, lens review, pillar, or question.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] improvement_plan_url
|
1052
|
+
# The improvement plan URL for a question.
|
1053
|
+
# @return [String]
|
1054
|
+
#
|
1055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImprovementSummary AWS API Documentation
|
1056
|
+
#
|
1057
|
+
class ImprovementSummary < Struct.new(
|
1058
|
+
:question_id,
|
1059
|
+
:pillar_id,
|
1060
|
+
:question_title,
|
1061
|
+
:risk,
|
1062
|
+
:improvement_plan_url)
|
1063
|
+
SENSITIVE = []
|
1064
|
+
include Aws::Structure
|
1065
|
+
end
|
1066
|
+
|
1067
|
+
# There is a problem with the AWS Well-Architected Tool API service.
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] message
|
1070
|
+
# Description of the error.
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/InternalServerException AWS API Documentation
|
1074
|
+
#
|
1075
|
+
class InternalServerException < Struct.new(
|
1076
|
+
:message)
|
1077
|
+
SENSITIVE = []
|
1078
|
+
include Aws::Structure
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# A lens review of a question.
|
1082
|
+
#
|
1083
|
+
# @!attribute [rw] lens_alias
|
1084
|
+
# The alias of the lens, for example, `serverless`.
|
1085
|
+
#
|
1086
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] lens_version
|
1090
|
+
# The version of the lens.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] lens_name
|
1094
|
+
# The full name of the lens.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] lens_status
|
1098
|
+
# The status of the lens.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] pillar_review_summaries
|
1102
|
+
# List of pillar review summaries of lens review in a workload.
|
1103
|
+
# @return [Array<Types::PillarReviewSummary>]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] updated_at
|
1106
|
+
# The date and time recorded.
|
1107
|
+
# @return [Time]
|
1108
|
+
#
|
1109
|
+
# @!attribute [rw] notes
|
1110
|
+
# The notes associated with the workload.
|
1111
|
+
# @return [String]
|
1112
|
+
#
|
1113
|
+
# @!attribute [rw] risk_counts
|
1114
|
+
# A map from risk names to the count of how questions have that
|
1115
|
+
# rating.
|
1116
|
+
# @return [Hash<String,Integer>]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] next_token
|
1119
|
+
# The token to use to retrieve the next set of results.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReview AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class LensReview < Struct.new(
|
1125
|
+
:lens_alias,
|
1126
|
+
:lens_version,
|
1127
|
+
:lens_name,
|
1128
|
+
:lens_status,
|
1129
|
+
:pillar_review_summaries,
|
1130
|
+
:updated_at,
|
1131
|
+
:notes,
|
1132
|
+
:risk_counts,
|
1133
|
+
:next_token)
|
1134
|
+
SENSITIVE = []
|
1135
|
+
include Aws::Structure
|
1136
|
+
end
|
1137
|
+
|
1138
|
+
# A report of a lens review.
|
1139
|
+
#
|
1140
|
+
# @!attribute [rw] lens_alias
|
1141
|
+
# The alias of the lens, for example, `serverless`.
|
1142
|
+
#
|
1143
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] base_64_string
|
1147
|
+
# The Base64-encoded string representation of a lens review report.
|
1148
|
+
#
|
1149
|
+
# This data can be used to create a PDF file.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReviewReport AWS API Documentation
|
1153
|
+
#
|
1154
|
+
class LensReviewReport < Struct.new(
|
1155
|
+
:lens_alias,
|
1156
|
+
:base_64_string)
|
1157
|
+
SENSITIVE = []
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# A lens review summary of a workload.
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] lens_alias
|
1164
|
+
# The alias of the lens, for example, `serverless`.
|
1165
|
+
#
|
1166
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1167
|
+
# @return [String]
|
1168
|
+
#
|
1169
|
+
# @!attribute [rw] lens_version
|
1170
|
+
# The version of the lens.
|
1171
|
+
# @return [String]
|
1172
|
+
#
|
1173
|
+
# @!attribute [rw] lens_name
|
1174
|
+
# The full name of the lens.
|
1175
|
+
# @return [String]
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] lens_status
|
1178
|
+
# The status of the lens.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] updated_at
|
1182
|
+
# The date and time recorded.
|
1183
|
+
# @return [Time]
|
1184
|
+
#
|
1185
|
+
# @!attribute [rw] risk_counts
|
1186
|
+
# A map from risk names to the count of how questions have that
|
1187
|
+
# rating.
|
1188
|
+
# @return [Hash<String,Integer>]
|
1189
|
+
#
|
1190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensReviewSummary AWS API Documentation
|
1191
|
+
#
|
1192
|
+
class LensReviewSummary < Struct.new(
|
1193
|
+
:lens_alias,
|
1194
|
+
:lens_version,
|
1195
|
+
:lens_name,
|
1196
|
+
:lens_status,
|
1197
|
+
:updated_at,
|
1198
|
+
:risk_counts)
|
1199
|
+
SENSITIVE = []
|
1200
|
+
include Aws::Structure
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
# A lens summary of a lens.
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] lens_alias
|
1206
|
+
# The alias of the lens, for example, `serverless`.
|
1207
|
+
#
|
1208
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] lens_version
|
1212
|
+
# The version of the lens.
|
1213
|
+
# @return [String]
|
1214
|
+
#
|
1215
|
+
# @!attribute [rw] lens_name
|
1216
|
+
# The full name of the lens.
|
1217
|
+
# @return [String]
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] description
|
1220
|
+
# The description of the lens.
|
1221
|
+
# @return [String]
|
1222
|
+
#
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensSummary AWS API Documentation
|
1224
|
+
#
|
1225
|
+
class LensSummary < Struct.new(
|
1226
|
+
:lens_alias,
|
1227
|
+
:lens_version,
|
1228
|
+
:lens_name,
|
1229
|
+
:description)
|
1230
|
+
SENSITIVE = []
|
1231
|
+
include Aws::Structure
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# Lens upgrade summary return object.
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] workload_id
|
1237
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1238
|
+
# Region.
|
1239
|
+
# @return [String]
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] workload_name
|
1242
|
+
# The name of the workload.
|
1243
|
+
#
|
1244
|
+
# The name must be unique within an account within a Region. Spaces
|
1245
|
+
# and capitalization are ignored when checking for uniqueness.
|
1246
|
+
# @return [String]
|
1247
|
+
#
|
1248
|
+
# @!attribute [rw] lens_alias
|
1249
|
+
# The alias of the lens, for example, `serverless`.
|
1250
|
+
#
|
1251
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1252
|
+
# @return [String]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] current_lens_version
|
1255
|
+
# The current version of the lens.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] latest_lens_version
|
1259
|
+
# The latest version of the lens.
|
1260
|
+
# @return [String]
|
1261
|
+
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensUpgradeSummary AWS API Documentation
|
1263
|
+
#
|
1264
|
+
class LensUpgradeSummary < Struct.new(
|
1265
|
+
:workload_id,
|
1266
|
+
:workload_name,
|
1267
|
+
:lens_alias,
|
1268
|
+
:current_lens_version,
|
1269
|
+
:latest_lens_version)
|
1270
|
+
SENSITIVE = []
|
1271
|
+
include Aws::Structure
|
1272
|
+
end
|
1273
|
+
|
1274
|
+
# Input to list answers.
|
1275
|
+
#
|
1276
|
+
# @note When making an API call, you may pass ListAnswersInput
|
1277
|
+
# data as a hash:
|
1278
|
+
#
|
1279
|
+
# {
|
1280
|
+
# workload_id: "WorkloadId", # required
|
1281
|
+
# lens_alias: "LensAlias", # required
|
1282
|
+
# pillar_id: "PillarId",
|
1283
|
+
# milestone_number: 1,
|
1284
|
+
# next_token: "NextToken",
|
1285
|
+
# max_results: 1,
|
1286
|
+
# }
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] workload_id
|
1289
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1290
|
+
# Region.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] lens_alias
|
1294
|
+
# The alias of the lens, for example, `serverless`.
|
1295
|
+
#
|
1296
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1297
|
+
# @return [String]
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] pillar_id
|
1300
|
+
# The ID used to identify a pillar, for example, `security`.
|
1301
|
+
#
|
1302
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] milestone_number
|
1306
|
+
# The milestone number.
|
1307
|
+
#
|
1308
|
+
# A workload can have a maximum of 100 milestones.
|
1309
|
+
# @return [Integer]
|
1310
|
+
#
|
1311
|
+
# @!attribute [rw] next_token
|
1312
|
+
# The token to use to retrieve the next set of results.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] max_results
|
1316
|
+
# The maximum number of results to return for this request.
|
1317
|
+
# @return [Integer]
|
1318
|
+
#
|
1319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswersInput AWS API Documentation
|
1320
|
+
#
|
1321
|
+
class ListAnswersInput < Struct.new(
|
1322
|
+
:workload_id,
|
1323
|
+
:lens_alias,
|
1324
|
+
:pillar_id,
|
1325
|
+
:milestone_number,
|
1326
|
+
:next_token,
|
1327
|
+
:max_results)
|
1328
|
+
SENSITIVE = []
|
1329
|
+
include Aws::Structure
|
1330
|
+
end
|
1331
|
+
|
1332
|
+
# Output of a list answers call.
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] workload_id
|
1335
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1336
|
+
# Region.
|
1337
|
+
# @return [String]
|
1338
|
+
#
|
1339
|
+
# @!attribute [rw] milestone_number
|
1340
|
+
# The milestone number.
|
1341
|
+
#
|
1342
|
+
# A workload can have a maximum of 100 milestones.
|
1343
|
+
# @return [Integer]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] lens_alias
|
1346
|
+
# The alias of the lens, for example, `serverless`.
|
1347
|
+
#
|
1348
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] answer_summaries
|
1352
|
+
# List of answer summaries of lens review in a workload.
|
1353
|
+
# @return [Array<Types::AnswerSummary>]
|
1354
|
+
#
|
1355
|
+
# @!attribute [rw] next_token
|
1356
|
+
# The token to use to retrieve the next set of results.
|
1357
|
+
# @return [String]
|
1358
|
+
#
|
1359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswersOutput AWS API Documentation
|
1360
|
+
#
|
1361
|
+
class ListAnswersOutput < Struct.new(
|
1362
|
+
:workload_id,
|
1363
|
+
:milestone_number,
|
1364
|
+
:lens_alias,
|
1365
|
+
:answer_summaries,
|
1366
|
+
:next_token)
|
1367
|
+
SENSITIVE = []
|
1368
|
+
include Aws::Structure
|
1369
|
+
end
|
1370
|
+
|
1371
|
+
# Input to list lens review improvements.
|
1372
|
+
#
|
1373
|
+
# @note When making an API call, you may pass ListLensReviewImprovementsInput
|
1374
|
+
# data as a hash:
|
1375
|
+
#
|
1376
|
+
# {
|
1377
|
+
# workload_id: "WorkloadId", # required
|
1378
|
+
# lens_alias: "LensAlias", # required
|
1379
|
+
# pillar_id: "PillarId",
|
1380
|
+
# milestone_number: 1,
|
1381
|
+
# next_token: "NextToken",
|
1382
|
+
# max_results: 1,
|
1383
|
+
# }
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] workload_id
|
1386
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1387
|
+
# Region.
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] lens_alias
|
1391
|
+
# The alias of the lens, for example, `serverless`.
|
1392
|
+
#
|
1393
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1396
|
+
# @!attribute [rw] pillar_id
|
1397
|
+
# The ID used to identify a pillar, for example, `security`.
|
1398
|
+
#
|
1399
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
1400
|
+
# @return [String]
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] milestone_number
|
1403
|
+
# The milestone number.
|
1404
|
+
#
|
1405
|
+
# A workload can have a maximum of 100 milestones.
|
1406
|
+
# @return [Integer]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] next_token
|
1409
|
+
# The token to use to retrieve the next set of results.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @!attribute [rw] max_results
|
1413
|
+
# The maximum number of results to return for this request.
|
1414
|
+
# @return [Integer]
|
1415
|
+
#
|
1416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovementsInput AWS API Documentation
|
1417
|
+
#
|
1418
|
+
class ListLensReviewImprovementsInput < Struct.new(
|
1419
|
+
:workload_id,
|
1420
|
+
:lens_alias,
|
1421
|
+
:pillar_id,
|
1422
|
+
:milestone_number,
|
1423
|
+
:next_token,
|
1424
|
+
:max_results)
|
1425
|
+
SENSITIVE = []
|
1426
|
+
include Aws::Structure
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# Output of a list lens review improvements call.
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] workload_id
|
1432
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1433
|
+
# Region.
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] milestone_number
|
1437
|
+
# The milestone number.
|
1438
|
+
#
|
1439
|
+
# A workload can have a maximum of 100 milestones.
|
1440
|
+
# @return [Integer]
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] lens_alias
|
1443
|
+
# The alias of the lens, for example, `serverless`.
|
1444
|
+
#
|
1445
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] improvement_summaries
|
1449
|
+
# List of improvement summaries of lens review in a workload.
|
1450
|
+
# @return [Array<Types::ImprovementSummary>]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] next_token
|
1453
|
+
# The token to use to retrieve the next set of results.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovementsOutput AWS API Documentation
|
1457
|
+
#
|
1458
|
+
class ListLensReviewImprovementsOutput < Struct.new(
|
1459
|
+
:workload_id,
|
1460
|
+
:milestone_number,
|
1461
|
+
:lens_alias,
|
1462
|
+
:improvement_summaries,
|
1463
|
+
:next_token)
|
1464
|
+
SENSITIVE = []
|
1465
|
+
include Aws::Structure
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
# Input to list lens reviews.
|
1469
|
+
#
|
1470
|
+
# @note When making an API call, you may pass ListLensReviewsInput
|
1471
|
+
# data as a hash:
|
1472
|
+
#
|
1473
|
+
# {
|
1474
|
+
# workload_id: "WorkloadId", # required
|
1475
|
+
# milestone_number: 1,
|
1476
|
+
# next_token: "NextToken",
|
1477
|
+
# max_results: 1,
|
1478
|
+
# }
|
1479
|
+
#
|
1480
|
+
# @!attribute [rw] workload_id
|
1481
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1482
|
+
# Region.
|
1483
|
+
# @return [String]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] milestone_number
|
1486
|
+
# The milestone number.
|
1487
|
+
#
|
1488
|
+
# A workload can have a maximum of 100 milestones.
|
1489
|
+
# @return [Integer]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] next_token
|
1492
|
+
# The token to use to retrieve the next set of results.
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] max_results
|
1496
|
+
# The maximum number of results to return for this request.
|
1497
|
+
# @return [Integer]
|
1498
|
+
#
|
1499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewsInput AWS API Documentation
|
1500
|
+
#
|
1501
|
+
class ListLensReviewsInput < Struct.new(
|
1502
|
+
:workload_id,
|
1503
|
+
:milestone_number,
|
1504
|
+
:next_token,
|
1505
|
+
:max_results)
|
1506
|
+
SENSITIVE = []
|
1507
|
+
include Aws::Structure
|
1508
|
+
end
|
1509
|
+
|
1510
|
+
# Output of a list lens reviews call.
|
1511
|
+
#
|
1512
|
+
# @!attribute [rw] workload_id
|
1513
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1514
|
+
# Region.
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] milestone_number
|
1518
|
+
# The milestone number.
|
1519
|
+
#
|
1520
|
+
# A workload can have a maximum of 100 milestones.
|
1521
|
+
# @return [Integer]
|
1522
|
+
#
|
1523
|
+
# @!attribute [rw] lens_review_summaries
|
1524
|
+
# List of lens summaries of lens reviews of a workload.
|
1525
|
+
# @return [Array<Types::LensReviewSummary>]
|
1526
|
+
#
|
1527
|
+
# @!attribute [rw] next_token
|
1528
|
+
# The token to use to retrieve the next set of results.
|
1529
|
+
# @return [String]
|
1530
|
+
#
|
1531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewsOutput AWS API Documentation
|
1532
|
+
#
|
1533
|
+
class ListLensReviewsOutput < Struct.new(
|
1534
|
+
:workload_id,
|
1535
|
+
:milestone_number,
|
1536
|
+
:lens_review_summaries,
|
1537
|
+
:next_token)
|
1538
|
+
SENSITIVE = []
|
1539
|
+
include Aws::Structure
|
1540
|
+
end
|
1541
|
+
|
1542
|
+
# Input to list lenses.
|
1543
|
+
#
|
1544
|
+
# @note When making an API call, you may pass ListLensesInput
|
1545
|
+
# data as a hash:
|
1546
|
+
#
|
1547
|
+
# {
|
1548
|
+
# next_token: "NextToken",
|
1549
|
+
# max_results: 1,
|
1550
|
+
# }
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] next_token
|
1553
|
+
# The token to use to retrieve the next set of results.
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] max_results
|
1557
|
+
# The maximum number of results to return for this request.
|
1558
|
+
# @return [Integer]
|
1559
|
+
#
|
1560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensesInput AWS API Documentation
|
1561
|
+
#
|
1562
|
+
class ListLensesInput < Struct.new(
|
1563
|
+
:next_token,
|
1564
|
+
:max_results)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# Output of a list lenses call.
|
1570
|
+
#
|
1571
|
+
# @!attribute [rw] lens_summaries
|
1572
|
+
# List of lens summaries of available lenses.
|
1573
|
+
# @return [Array<Types::LensSummary>]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] next_token
|
1576
|
+
# The token to use to retrieve the next set of results.
|
1577
|
+
# @return [String]
|
1578
|
+
#
|
1579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensesOutput AWS API Documentation
|
1580
|
+
#
|
1581
|
+
class ListLensesOutput < Struct.new(
|
1582
|
+
:lens_summaries,
|
1583
|
+
:next_token)
|
1584
|
+
SENSITIVE = []
|
1585
|
+
include Aws::Structure
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# Input to list all milestones for a workload.
|
1589
|
+
#
|
1590
|
+
# @note When making an API call, you may pass ListMilestonesInput
|
1591
|
+
# data as a hash:
|
1592
|
+
#
|
1593
|
+
# {
|
1594
|
+
# workload_id: "WorkloadId", # required
|
1595
|
+
# next_token: "NextToken",
|
1596
|
+
# max_results: 1,
|
1597
|
+
# }
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] workload_id
|
1600
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1601
|
+
# Region.
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] next_token
|
1605
|
+
# The token to use to retrieve the next set of results.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] max_results
|
1609
|
+
# The maximum number of results to return for this request.
|
1610
|
+
# @return [Integer]
|
1611
|
+
#
|
1612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestonesInput AWS API Documentation
|
1613
|
+
#
|
1614
|
+
class ListMilestonesInput < Struct.new(
|
1615
|
+
:workload_id,
|
1616
|
+
:next_token,
|
1617
|
+
:max_results)
|
1618
|
+
SENSITIVE = []
|
1619
|
+
include Aws::Structure
|
1620
|
+
end
|
1621
|
+
|
1622
|
+
# Output of a list milestones call.
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] workload_id
|
1625
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1626
|
+
# Region.
|
1627
|
+
# @return [String]
|
1628
|
+
#
|
1629
|
+
# @!attribute [rw] milestone_summaries
|
1630
|
+
# A list of milestone summaries.
|
1631
|
+
# @return [Array<Types::MilestoneSummary>]
|
1632
|
+
#
|
1633
|
+
# @!attribute [rw] next_token
|
1634
|
+
# The token to use to retrieve the next set of results.
|
1635
|
+
# @return [String]
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestonesOutput AWS API Documentation
|
1638
|
+
#
|
1639
|
+
class ListMilestonesOutput < Struct.new(
|
1640
|
+
:workload_id,
|
1641
|
+
:milestone_summaries,
|
1642
|
+
:next_token)
|
1643
|
+
SENSITIVE = []
|
1644
|
+
include Aws::Structure
|
1645
|
+
end
|
1646
|
+
|
1647
|
+
# @note When making an API call, you may pass ListNotificationsInput
|
1648
|
+
# data as a hash:
|
1649
|
+
#
|
1650
|
+
# {
|
1651
|
+
# workload_id: "WorkloadId",
|
1652
|
+
# next_token: "NextToken",
|
1653
|
+
# max_results: 1,
|
1654
|
+
# }
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] workload_id
|
1657
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1658
|
+
# Region.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] next_token
|
1662
|
+
# The token to use to retrieve the next set of results.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] max_results
|
1666
|
+
# The maximum number of results to return for this request.
|
1667
|
+
# @return [Integer]
|
1668
|
+
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotificationsInput AWS API Documentation
|
1670
|
+
#
|
1671
|
+
class ListNotificationsInput < Struct.new(
|
1672
|
+
:workload_id,
|
1673
|
+
:next_token,
|
1674
|
+
:max_results)
|
1675
|
+
SENSITIVE = []
|
1676
|
+
include Aws::Structure
|
1677
|
+
end
|
1678
|
+
|
1679
|
+
# @!attribute [rw] notification_summaries
|
1680
|
+
# List of lens notification summaries in a workload.
|
1681
|
+
# @return [Array<Types::NotificationSummary>]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] next_token
|
1684
|
+
# The token to use to retrieve the next set of results.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotificationsOutput AWS API Documentation
|
1688
|
+
#
|
1689
|
+
class ListNotificationsOutput < Struct.new(
|
1690
|
+
:notification_summaries,
|
1691
|
+
:next_token)
|
1692
|
+
SENSITIVE = []
|
1693
|
+
include Aws::Structure
|
1694
|
+
end
|
1695
|
+
|
1696
|
+
# Input for List Share Invitations
|
1697
|
+
#
|
1698
|
+
# @note When making an API call, you may pass ListShareInvitationsInput
|
1699
|
+
# data as a hash:
|
1700
|
+
#
|
1701
|
+
# {
|
1702
|
+
# workload_name_prefix: "WorkloadNamePrefix",
|
1703
|
+
# next_token: "NextToken",
|
1704
|
+
# max_results: 1,
|
1705
|
+
# }
|
1706
|
+
#
|
1707
|
+
# @!attribute [rw] workload_name_prefix
|
1708
|
+
# An optional string added to the beginning of each workload name
|
1709
|
+
# returned in the results.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @!attribute [rw] next_token
|
1713
|
+
# The token to use to retrieve the next set of results.
|
1714
|
+
# @return [String]
|
1715
|
+
#
|
1716
|
+
# @!attribute [rw] max_results
|
1717
|
+
# The maximum number of results to return for this request.
|
1718
|
+
# @return [Integer]
|
1719
|
+
#
|
1720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitationsInput AWS API Documentation
|
1721
|
+
#
|
1722
|
+
class ListShareInvitationsInput < Struct.new(
|
1723
|
+
:workload_name_prefix,
|
1724
|
+
:next_token,
|
1725
|
+
:max_results)
|
1726
|
+
SENSITIVE = []
|
1727
|
+
include Aws::Structure
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Input for List Share Invitations
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] share_invitation_summaries
|
1733
|
+
# List of share invitation summaries in a workload.
|
1734
|
+
# @return [Array<Types::ShareInvitationSummary>]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] next_token
|
1737
|
+
# The token to use to retrieve the next set of results.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitationsOutput AWS API Documentation
|
1741
|
+
#
|
1742
|
+
class ListShareInvitationsOutput < Struct.new(
|
1743
|
+
:share_invitation_summaries,
|
1744
|
+
:next_token)
|
1745
|
+
SENSITIVE = []
|
1746
|
+
include Aws::Structure
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# Input for List Workload Share
|
1750
|
+
#
|
1751
|
+
# @note When making an API call, you may pass ListWorkloadSharesInput
|
1752
|
+
# data as a hash:
|
1753
|
+
#
|
1754
|
+
# {
|
1755
|
+
# workload_id: "WorkloadId", # required
|
1756
|
+
# shared_with_prefix: "SharedWithPrefix",
|
1757
|
+
# next_token: "NextToken",
|
1758
|
+
# max_results: 1,
|
1759
|
+
# }
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] workload_id
|
1762
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1763
|
+
# Region.
|
1764
|
+
# @return [String]
|
1765
|
+
#
|
1766
|
+
# @!attribute [rw] shared_with_prefix
|
1767
|
+
# The AWS account ID or IAM role with which the workload is shared.
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] next_token
|
1771
|
+
# The token to use to retrieve the next set of results.
|
1772
|
+
# @return [String]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] max_results
|
1775
|
+
# The maximum number of results to return for this request.
|
1776
|
+
# @return [Integer]
|
1777
|
+
#
|
1778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadSharesInput AWS API Documentation
|
1779
|
+
#
|
1780
|
+
class ListWorkloadSharesInput < Struct.new(
|
1781
|
+
:workload_id,
|
1782
|
+
:shared_with_prefix,
|
1783
|
+
:next_token,
|
1784
|
+
:max_results)
|
1785
|
+
SENSITIVE = []
|
1786
|
+
include Aws::Structure
|
1787
|
+
end
|
1788
|
+
|
1789
|
+
# Input for List Workload Share
|
1790
|
+
#
|
1791
|
+
# @!attribute [rw] workload_id
|
1792
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
1793
|
+
# Region.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] workload_share_summaries
|
1797
|
+
# A list of workload share summaries.
|
1798
|
+
# @return [Array<Types::WorkloadShareSummary>]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] next_token
|
1801
|
+
# The token to use to retrieve the next set of results.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadSharesOutput AWS API Documentation
|
1805
|
+
#
|
1806
|
+
class ListWorkloadSharesOutput < Struct.new(
|
1807
|
+
:workload_id,
|
1808
|
+
:workload_share_summaries,
|
1809
|
+
:next_token)
|
1810
|
+
SENSITIVE = []
|
1811
|
+
include Aws::Structure
|
1812
|
+
end
|
1813
|
+
|
1814
|
+
# Input to list all workloads.
|
1815
|
+
#
|
1816
|
+
# @note When making an API call, you may pass ListWorkloadsInput
|
1817
|
+
# data as a hash:
|
1818
|
+
#
|
1819
|
+
# {
|
1820
|
+
# workload_name_prefix: "WorkloadNamePrefix",
|
1821
|
+
# next_token: "NextToken",
|
1822
|
+
# max_results: 1,
|
1823
|
+
# }
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] workload_name_prefix
|
1826
|
+
# An optional string added to the beginning of each workload name
|
1827
|
+
# returned in the results.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] next_token
|
1831
|
+
# The token to use to retrieve the next set of results.
|
1832
|
+
# @return [String]
|
1833
|
+
#
|
1834
|
+
# @!attribute [rw] max_results
|
1835
|
+
# The maximum number of results to return for this request.
|
1836
|
+
# @return [Integer]
|
1837
|
+
#
|
1838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadsInput AWS API Documentation
|
1839
|
+
#
|
1840
|
+
class ListWorkloadsInput < Struct.new(
|
1841
|
+
:workload_name_prefix,
|
1842
|
+
:next_token,
|
1843
|
+
:max_results)
|
1844
|
+
SENSITIVE = []
|
1845
|
+
include Aws::Structure
|
1846
|
+
end
|
1847
|
+
|
1848
|
+
# Output of a list workloads call.
|
1849
|
+
#
|
1850
|
+
# @!attribute [rw] workload_summaries
|
1851
|
+
# A list of workload summaries.
|
1852
|
+
# @return [Array<Types::WorkloadSummary>]
|
1853
|
+
#
|
1854
|
+
# @!attribute [rw] next_token
|
1855
|
+
# The token to use to retrieve the next set of results.
|
1856
|
+
# @return [String]
|
1857
|
+
#
|
1858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadsOutput AWS API Documentation
|
1859
|
+
#
|
1860
|
+
class ListWorkloadsOutput < Struct.new(
|
1861
|
+
:workload_summaries,
|
1862
|
+
:next_token)
|
1863
|
+
SENSITIVE = []
|
1864
|
+
include Aws::Structure
|
1865
|
+
end
|
1866
|
+
|
1867
|
+
# A milestone return object.
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] milestone_number
|
1870
|
+
# The milestone number.
|
1871
|
+
#
|
1872
|
+
# A workload can have a maximum of 100 milestones.
|
1873
|
+
# @return [Integer]
|
1874
|
+
#
|
1875
|
+
# @!attribute [rw] milestone_name
|
1876
|
+
# The name of the milestone in a workload.
|
1877
|
+
#
|
1878
|
+
# Milestone names must be unique within a workload.
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] recorded_at
|
1882
|
+
# The date and time recorded.
|
1883
|
+
# @return [Time]
|
1884
|
+
#
|
1885
|
+
# @!attribute [rw] workload
|
1886
|
+
# A workload return object.
|
1887
|
+
# @return [Types::Workload]
|
1888
|
+
#
|
1889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Milestone AWS API Documentation
|
1890
|
+
#
|
1891
|
+
class Milestone < Struct.new(
|
1892
|
+
:milestone_number,
|
1893
|
+
:milestone_name,
|
1894
|
+
:recorded_at,
|
1895
|
+
:workload)
|
1896
|
+
SENSITIVE = []
|
1897
|
+
include Aws::Structure
|
1898
|
+
end
|
1899
|
+
|
1900
|
+
# A milestone summary return object.
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] milestone_number
|
1903
|
+
# The milestone number.
|
1904
|
+
#
|
1905
|
+
# A workload can have a maximum of 100 milestones.
|
1906
|
+
# @return [Integer]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] milestone_name
|
1909
|
+
# The name of the milestone in a workload.
|
1910
|
+
#
|
1911
|
+
# Milestone names must be unique within a workload.
|
1912
|
+
# @return [String]
|
1913
|
+
#
|
1914
|
+
# @!attribute [rw] recorded_at
|
1915
|
+
# The date and time recorded.
|
1916
|
+
# @return [Time]
|
1917
|
+
#
|
1918
|
+
# @!attribute [rw] workload_summary
|
1919
|
+
# A workload summary return object.
|
1920
|
+
# @return [Types::WorkloadSummary]
|
1921
|
+
#
|
1922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/MilestoneSummary AWS API Documentation
|
1923
|
+
#
|
1924
|
+
class MilestoneSummary < Struct.new(
|
1925
|
+
:milestone_number,
|
1926
|
+
:milestone_name,
|
1927
|
+
:recorded_at,
|
1928
|
+
:workload_summary)
|
1929
|
+
SENSITIVE = []
|
1930
|
+
include Aws::Structure
|
1931
|
+
end
|
1932
|
+
|
1933
|
+
# A notification summary return object.
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] type
|
1936
|
+
# The type of notification.
|
1937
|
+
# @return [String]
|
1938
|
+
#
|
1939
|
+
# @!attribute [rw] lens_upgrade_summary
|
1940
|
+
# Summary of lens upgrade.
|
1941
|
+
# @return [Types::LensUpgradeSummary]
|
1942
|
+
#
|
1943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/NotificationSummary AWS API Documentation
|
1944
|
+
#
|
1945
|
+
class NotificationSummary < Struct.new(
|
1946
|
+
:type,
|
1947
|
+
:lens_upgrade_summary)
|
1948
|
+
SENSITIVE = []
|
1949
|
+
include Aws::Structure
|
1950
|
+
end
|
1951
|
+
|
1952
|
+
# A pillar difference return object.
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] pillar_id
|
1955
|
+
# The ID used to identify a pillar, for example, `security`.
|
1956
|
+
#
|
1957
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] difference_status
|
1961
|
+
# Indicates the type of change to the pillar.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] question_differences
|
1965
|
+
# List of question differences.
|
1966
|
+
# @return [Array<Types::QuestionDifference>]
|
1967
|
+
#
|
1968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/PillarDifference AWS API Documentation
|
1969
|
+
#
|
1970
|
+
class PillarDifference < Struct.new(
|
1971
|
+
:pillar_id,
|
1972
|
+
:difference_status,
|
1973
|
+
:question_differences)
|
1974
|
+
SENSITIVE = []
|
1975
|
+
include Aws::Structure
|
1976
|
+
end
|
1977
|
+
|
1978
|
+
# A pillar review summary of a lens review.
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] pillar_id
|
1981
|
+
# The ID used to identify a pillar, for example, `security`.
|
1982
|
+
#
|
1983
|
+
# A pillar is identified by its PillarReviewSummary$PillarId.
|
1984
|
+
# @return [String]
|
1985
|
+
#
|
1986
|
+
# @!attribute [rw] pillar_name
|
1987
|
+
# The name of the pillar.
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] notes
|
1991
|
+
# The notes associated with the workload.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] risk_counts
|
1995
|
+
# A map from risk names to the count of how questions have that
|
1996
|
+
# rating.
|
1997
|
+
# @return [Hash<String,Integer>]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/PillarReviewSummary AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class PillarReviewSummary < Struct.new(
|
2002
|
+
:pillar_id,
|
2003
|
+
:pillar_name,
|
2004
|
+
:notes,
|
2005
|
+
:risk_counts)
|
2006
|
+
SENSITIVE = []
|
2007
|
+
include Aws::Structure
|
2008
|
+
end
|
2009
|
+
|
2010
|
+
# A question difference return object.
|
2011
|
+
#
|
2012
|
+
# @!attribute [rw] question_id
|
2013
|
+
# The ID of the question.
|
2014
|
+
# @return [String]
|
2015
|
+
#
|
2016
|
+
# @!attribute [rw] question_title
|
2017
|
+
# The title of the question.
|
2018
|
+
# @return [String]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] difference_status
|
2021
|
+
# Indicates the type of change to the question.
|
2022
|
+
# @return [String]
|
2023
|
+
#
|
2024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/QuestionDifference AWS API Documentation
|
2025
|
+
#
|
2026
|
+
class QuestionDifference < Struct.new(
|
2027
|
+
:question_id,
|
2028
|
+
:question_title,
|
2029
|
+
:difference_status)
|
2030
|
+
SENSITIVE = []
|
2031
|
+
include Aws::Structure
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
# The requested resource was not found.
|
2035
|
+
#
|
2036
|
+
# @!attribute [rw] message
|
2037
|
+
# Description of the error.
|
2038
|
+
# @return [String]
|
2039
|
+
#
|
2040
|
+
# @!attribute [rw] resource_id
|
2041
|
+
# Identifier of the resource affected.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2044
|
+
# @!attribute [rw] resource_type
|
2045
|
+
# Type of the resource affected.
|
2046
|
+
# @return [String]
|
2047
|
+
#
|
2048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ResourceNotFoundException AWS API Documentation
|
2049
|
+
#
|
2050
|
+
class ResourceNotFoundException < Struct.new(
|
2051
|
+
:message,
|
2052
|
+
:resource_id,
|
2053
|
+
:resource_type)
|
2054
|
+
SENSITIVE = []
|
2055
|
+
include Aws::Structure
|
2056
|
+
end
|
2057
|
+
|
2058
|
+
# The user has reached their resource quota.
|
2059
|
+
#
|
2060
|
+
# @!attribute [rw] message
|
2061
|
+
# Description of the error.
|
2062
|
+
# @return [String]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] resource_id
|
2065
|
+
# Identifier of the resource affected.
|
2066
|
+
# @return [String]
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] resource_type
|
2069
|
+
# Type of the resource affected.
|
2070
|
+
# @return [String]
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] quota_code
|
2073
|
+
# Service Quotas requirement to identify originating quota.
|
2074
|
+
# @return [String]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] service_code
|
2077
|
+
# Service Quotas requirement to identify originating service.
|
2078
|
+
# @return [String]
|
2079
|
+
#
|
2080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ServiceQuotaExceededException AWS API Documentation
|
2081
|
+
#
|
2082
|
+
class ServiceQuotaExceededException < Struct.new(
|
2083
|
+
:message,
|
2084
|
+
:resource_id,
|
2085
|
+
:resource_type,
|
2086
|
+
:quota_code,
|
2087
|
+
:service_code)
|
2088
|
+
SENSITIVE = []
|
2089
|
+
include Aws::Structure
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# The share invitation.
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] share_invitation_id
|
2095
|
+
# The ID assigned to the share invitation.
|
2096
|
+
# @return [String]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] workload_id
|
2099
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2100
|
+
# Region.
|
2101
|
+
# @return [String]
|
2102
|
+
#
|
2103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitation AWS API Documentation
|
2104
|
+
#
|
2105
|
+
class ShareInvitation < Struct.new(
|
2106
|
+
:share_invitation_id,
|
2107
|
+
:workload_id)
|
2108
|
+
SENSITIVE = []
|
2109
|
+
include Aws::Structure
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# A share invitation summary return object.
|
2113
|
+
#
|
2114
|
+
# @!attribute [rw] share_invitation_id
|
2115
|
+
# The ID assigned to the share invitation.
|
2116
|
+
# @return [String]
|
2117
|
+
#
|
2118
|
+
# @!attribute [rw] shared_by
|
2119
|
+
# An AWS account ID.
|
2120
|
+
# @return [String]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] shared_with
|
2123
|
+
# The AWS account ID or IAM role with which the workload is shared.
|
2124
|
+
# @return [String]
|
2125
|
+
#
|
2126
|
+
# @!attribute [rw] permission_type
|
2127
|
+
# Permission granted on a workload share.
|
2128
|
+
# @return [String]
|
2129
|
+
#
|
2130
|
+
# @!attribute [rw] workload_name
|
2131
|
+
# The name of the workload.
|
2132
|
+
#
|
2133
|
+
# The name must be unique within an account within a Region. Spaces
|
2134
|
+
# and capitalization are ignored when checking for uniqueness.
|
2135
|
+
# @return [String]
|
2136
|
+
#
|
2137
|
+
# @!attribute [rw] workload_id
|
2138
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2139
|
+
# Region.
|
2140
|
+
# @return [String]
|
2141
|
+
#
|
2142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitationSummary AWS API Documentation
|
2143
|
+
#
|
2144
|
+
class ShareInvitationSummary < Struct.new(
|
2145
|
+
:share_invitation_id,
|
2146
|
+
:shared_by,
|
2147
|
+
:shared_with,
|
2148
|
+
:permission_type,
|
2149
|
+
:workload_name,
|
2150
|
+
:workload_id)
|
2151
|
+
SENSITIVE = []
|
2152
|
+
include Aws::Structure
|
2153
|
+
end
|
2154
|
+
|
2155
|
+
# Request was denied due to request throttling.
|
2156
|
+
#
|
2157
|
+
# @!attribute [rw] message
|
2158
|
+
# Description of the error.
|
2159
|
+
# @return [String]
|
2160
|
+
#
|
2161
|
+
# @!attribute [rw] quota_code
|
2162
|
+
# Service Quotas requirement to identify originating quota.
|
2163
|
+
# @return [String]
|
2164
|
+
#
|
2165
|
+
# @!attribute [rw] service_code
|
2166
|
+
# Service Quotas requirement to identify originating service.
|
2167
|
+
# @return [String]
|
2168
|
+
#
|
2169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ThrottlingException AWS API Documentation
|
2170
|
+
#
|
2171
|
+
class ThrottlingException < Struct.new(
|
2172
|
+
:message,
|
2173
|
+
:quota_code,
|
2174
|
+
:service_code)
|
2175
|
+
SENSITIVE = []
|
2176
|
+
include Aws::Structure
|
2177
|
+
end
|
2178
|
+
|
2179
|
+
# Input to update answer.
|
2180
|
+
#
|
2181
|
+
# @note When making an API call, you may pass UpdateAnswerInput
|
2182
|
+
# data as a hash:
|
2183
|
+
#
|
2184
|
+
# {
|
2185
|
+
# workload_id: "WorkloadId", # required
|
2186
|
+
# lens_alias: "LensAlias", # required
|
2187
|
+
# question_id: "QuestionId", # required
|
2188
|
+
# selected_choices: ["ChoiceId"],
|
2189
|
+
# notes: "Notes",
|
2190
|
+
# is_applicable: false,
|
2191
|
+
# }
|
2192
|
+
#
|
2193
|
+
# @!attribute [rw] workload_id
|
2194
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2195
|
+
# Region.
|
2196
|
+
# @return [String]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] lens_alias
|
2199
|
+
# The alias of the lens, for example, `serverless`.
|
2200
|
+
#
|
2201
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2202
|
+
# @return [String]
|
2203
|
+
#
|
2204
|
+
# @!attribute [rw] question_id
|
2205
|
+
# The ID of the question.
|
2206
|
+
# @return [String]
|
2207
|
+
#
|
2208
|
+
# @!attribute [rw] selected_choices
|
2209
|
+
# List of selected choice IDs in a question answer.
|
2210
|
+
# @return [Array<String>]
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] notes
|
2213
|
+
# The notes associated with the workload.
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] is_applicable
|
2217
|
+
# Defines whether this question is applicable to a lens review.
|
2218
|
+
# @return [Boolean]
|
2219
|
+
#
|
2220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswerInput AWS API Documentation
|
2221
|
+
#
|
2222
|
+
class UpdateAnswerInput < Struct.new(
|
2223
|
+
:workload_id,
|
2224
|
+
:lens_alias,
|
2225
|
+
:question_id,
|
2226
|
+
:selected_choices,
|
2227
|
+
:notes,
|
2228
|
+
:is_applicable)
|
2229
|
+
SENSITIVE = []
|
2230
|
+
include Aws::Structure
|
2231
|
+
end
|
2232
|
+
|
2233
|
+
# Output of a update answer call.
|
2234
|
+
#
|
2235
|
+
# @!attribute [rw] workload_id
|
2236
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2237
|
+
# Region.
|
2238
|
+
# @return [String]
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] lens_alias
|
2241
|
+
# The alias of the lens, for example, `serverless`.
|
2242
|
+
#
|
2243
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2244
|
+
# @return [String]
|
2245
|
+
#
|
2246
|
+
# @!attribute [rw] answer
|
2247
|
+
# An answer of the question.
|
2248
|
+
# @return [Types::Answer]
|
2249
|
+
#
|
2250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswerOutput AWS API Documentation
|
2251
|
+
#
|
2252
|
+
class UpdateAnswerOutput < Struct.new(
|
2253
|
+
:workload_id,
|
2254
|
+
:lens_alias,
|
2255
|
+
:answer)
|
2256
|
+
SENSITIVE = []
|
2257
|
+
include Aws::Structure
|
2258
|
+
end
|
2259
|
+
|
2260
|
+
# Input for update lens review.
|
2261
|
+
#
|
2262
|
+
# @note When making an API call, you may pass UpdateLensReviewInput
|
2263
|
+
# data as a hash:
|
2264
|
+
#
|
2265
|
+
# {
|
2266
|
+
# workload_id: "WorkloadId", # required
|
2267
|
+
# lens_alias: "LensAlias", # required
|
2268
|
+
# lens_notes: "Notes",
|
2269
|
+
# pillar_notes: {
|
2270
|
+
# "PillarId" => "Notes",
|
2271
|
+
# },
|
2272
|
+
# }
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] workload_id
|
2275
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2276
|
+
# Region.
|
2277
|
+
# @return [String]
|
2278
|
+
#
|
2279
|
+
# @!attribute [rw] lens_alias
|
2280
|
+
# The alias of the lens, for example, `serverless`.
|
2281
|
+
#
|
2282
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2283
|
+
# @return [String]
|
2284
|
+
#
|
2285
|
+
# @!attribute [rw] lens_notes
|
2286
|
+
# The notes associated with the workload.
|
2287
|
+
# @return [String]
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] pillar_notes
|
2290
|
+
# List of pillar notes of a lens review in a workload.
|
2291
|
+
# @return [Hash<String,String>]
|
2292
|
+
#
|
2293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReviewInput AWS API Documentation
|
2294
|
+
#
|
2295
|
+
class UpdateLensReviewInput < Struct.new(
|
2296
|
+
:workload_id,
|
2297
|
+
:lens_alias,
|
2298
|
+
:lens_notes,
|
2299
|
+
:pillar_notes)
|
2300
|
+
SENSITIVE = []
|
2301
|
+
include Aws::Structure
|
2302
|
+
end
|
2303
|
+
|
2304
|
+
# Output of a update lens review call.
|
2305
|
+
#
|
2306
|
+
# @!attribute [rw] workload_id
|
2307
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2308
|
+
# Region.
|
2309
|
+
# @return [String]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] lens_review
|
2312
|
+
# A lens review of a question.
|
2313
|
+
# @return [Types::LensReview]
|
2314
|
+
#
|
2315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReviewOutput AWS API Documentation
|
2316
|
+
#
|
2317
|
+
class UpdateLensReviewOutput < Struct.new(
|
2318
|
+
:workload_id,
|
2319
|
+
:lens_review)
|
2320
|
+
SENSITIVE = []
|
2321
|
+
include Aws::Structure
|
2322
|
+
end
|
2323
|
+
|
2324
|
+
# Input for Update Share Invitation
|
2325
|
+
#
|
2326
|
+
# @note When making an API call, you may pass UpdateShareInvitationInput
|
2327
|
+
# data as a hash:
|
2328
|
+
#
|
2329
|
+
# {
|
2330
|
+
# share_invitation_id: "ShareInvitationId", # required
|
2331
|
+
# share_invitation_action: "ACCEPT", # required, accepts ACCEPT, REJECT
|
2332
|
+
# }
|
2333
|
+
#
|
2334
|
+
# @!attribute [rw] share_invitation_id
|
2335
|
+
# The ID assigned to the share invitation.
|
2336
|
+
# @return [String]
|
2337
|
+
#
|
2338
|
+
# @!attribute [rw] share_invitation_action
|
2339
|
+
# Share invitation action taken by contributor.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitationInput AWS API Documentation
|
2343
|
+
#
|
2344
|
+
class UpdateShareInvitationInput < Struct.new(
|
2345
|
+
:share_invitation_id,
|
2346
|
+
:share_invitation_action)
|
2347
|
+
SENSITIVE = []
|
2348
|
+
include Aws::Structure
|
2349
|
+
end
|
2350
|
+
|
2351
|
+
# @!attribute [rw] share_invitation
|
2352
|
+
# The updated workload share invitation.
|
2353
|
+
# @return [Types::ShareInvitation]
|
2354
|
+
#
|
2355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitationOutput AWS API Documentation
|
2356
|
+
#
|
2357
|
+
class UpdateShareInvitationOutput < Struct.new(
|
2358
|
+
:share_invitation)
|
2359
|
+
SENSITIVE = []
|
2360
|
+
include Aws::Structure
|
2361
|
+
end
|
2362
|
+
|
2363
|
+
# Input to update a workload.
|
2364
|
+
#
|
2365
|
+
# @note When making an API call, you may pass UpdateWorkloadInput
|
2366
|
+
# data as a hash:
|
2367
|
+
#
|
2368
|
+
# {
|
2369
|
+
# workload_id: "WorkloadId", # required
|
2370
|
+
# workload_name: "WorkloadName",
|
2371
|
+
# description: "WorkloadDescription",
|
2372
|
+
# environment: "PRODUCTION", # accepts PRODUCTION, PREPRODUCTION
|
2373
|
+
# account_ids: ["AwsAccountId"],
|
2374
|
+
# aws_regions: ["AwsRegion"],
|
2375
|
+
# non_aws_regions: ["WorkloadNonAwsRegion"],
|
2376
|
+
# pillar_priorities: ["PillarId"],
|
2377
|
+
# architectural_design: "WorkloadArchitecturalDesign",
|
2378
|
+
# review_owner: "WorkloadReviewOwner",
|
2379
|
+
# is_review_owner_update_acknowledged: false,
|
2380
|
+
# industry_type: "WorkloadIndustryType",
|
2381
|
+
# industry: "WorkloadIndustry",
|
2382
|
+
# notes: "Notes",
|
2383
|
+
# improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
|
2384
|
+
# }
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] workload_id
|
2387
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2388
|
+
# Region.
|
2389
|
+
# @return [String]
|
2390
|
+
#
|
2391
|
+
# @!attribute [rw] workload_name
|
2392
|
+
# The name of the workload.
|
2393
|
+
#
|
2394
|
+
# The name must be unique within an account within a Region. Spaces
|
2395
|
+
# and capitalization are ignored when checking for uniqueness.
|
2396
|
+
# @return [String]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] description
|
2399
|
+
# The description for the workload.
|
2400
|
+
# @return [String]
|
2401
|
+
#
|
2402
|
+
# @!attribute [rw] environment
|
2403
|
+
# The environment for the workload.
|
2404
|
+
# @return [String]
|
2405
|
+
#
|
2406
|
+
# @!attribute [rw] account_ids
|
2407
|
+
# The list of AWS account IDs associated with the workload.
|
2408
|
+
# @return [Array<String>]
|
2409
|
+
#
|
2410
|
+
# @!attribute [rw] aws_regions
|
2411
|
+
# The list of AWS Regions associated with the workload, for example,
|
2412
|
+
# `us-east-2`, or `ca-central-1`.
|
2413
|
+
# @return [Array<String>]
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] non_aws_regions
|
2416
|
+
# The list of non-AWS Regions associated with the workload.
|
2417
|
+
# @return [Array<String>]
|
2418
|
+
#
|
2419
|
+
# @!attribute [rw] pillar_priorities
|
2420
|
+
# The priorities of the pillars, which are used to order items in the
|
2421
|
+
# improvement plan. Each pillar is represented by its
|
2422
|
+
# PillarReviewSummary$PillarId.
|
2423
|
+
# @return [Array<String>]
|
2424
|
+
#
|
2425
|
+
# @!attribute [rw] architectural_design
|
2426
|
+
# The URL of the architectural design for the workload.
|
2427
|
+
# @return [String]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] review_owner
|
2430
|
+
# The review owner of the workload. The name, email address, or
|
2431
|
+
# identifier for the primary group or individual that owns the
|
2432
|
+
# workload review process.
|
2433
|
+
# @return [String]
|
2434
|
+
#
|
2435
|
+
# @!attribute [rw] is_review_owner_update_acknowledged
|
2436
|
+
# Flag indicating whether the workload owner has acknowledged that the
|
2437
|
+
# *Review owner* field is required.
|
2438
|
+
#
|
2439
|
+
# If a **Review owner** is not added to the workload within 60 days of
|
2440
|
+
# acknowledgement, access to the workload is restricted until an owner
|
2441
|
+
# is added.
|
2442
|
+
# @return [Boolean]
|
2443
|
+
#
|
2444
|
+
# @!attribute [rw] industry_type
|
2445
|
+
# The industry type for the workload.
|
2446
|
+
#
|
2447
|
+
# If specified, must be one of the following:
|
2448
|
+
#
|
2449
|
+
# * `Agriculture`
|
2450
|
+
#
|
2451
|
+
# * `Automobile`
|
2452
|
+
#
|
2453
|
+
# * `Defense`
|
2454
|
+
#
|
2455
|
+
# * `Design and Engineering`
|
2456
|
+
#
|
2457
|
+
# * `Digital Advertising`
|
2458
|
+
#
|
2459
|
+
# * `Education`
|
2460
|
+
#
|
2461
|
+
# * `Environmental Protection`
|
2462
|
+
#
|
2463
|
+
# * `Financial Services`
|
2464
|
+
#
|
2465
|
+
# * `Gaming`
|
2466
|
+
#
|
2467
|
+
# * `General Public Services`
|
2468
|
+
#
|
2469
|
+
# * `Healthcare`
|
2470
|
+
#
|
2471
|
+
# * `Hospitality`
|
2472
|
+
#
|
2473
|
+
# * `InfoTech`
|
2474
|
+
#
|
2475
|
+
# * `Justice and Public Safety`
|
2476
|
+
#
|
2477
|
+
# * `Life Sciences`
|
2478
|
+
#
|
2479
|
+
# * `Manufacturing`
|
2480
|
+
#
|
2481
|
+
# * `Media & Entertainment`
|
2482
|
+
#
|
2483
|
+
# * `Mining & Resources`
|
2484
|
+
#
|
2485
|
+
# * `Oil & Gas`
|
2486
|
+
#
|
2487
|
+
# * `Power & Utilities`
|
2488
|
+
#
|
2489
|
+
# * `Professional Services`
|
2490
|
+
#
|
2491
|
+
# * `Real Estate & Construction`
|
2492
|
+
#
|
2493
|
+
# * `Retail & Wholesale`
|
2494
|
+
#
|
2495
|
+
# * `Social Protection`
|
2496
|
+
#
|
2497
|
+
# * `Telecommunications`
|
2498
|
+
#
|
2499
|
+
# * `Travel, Transportation & Logistics`
|
2500
|
+
#
|
2501
|
+
# * `Other`
|
2502
|
+
# @return [String]
|
2503
|
+
#
|
2504
|
+
# @!attribute [rw] industry
|
2505
|
+
# The industry for the workload.
|
2506
|
+
# @return [String]
|
2507
|
+
#
|
2508
|
+
# @!attribute [rw] notes
|
2509
|
+
# The notes associated with the workload.
|
2510
|
+
# @return [String]
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] improvement_status
|
2513
|
+
# The improvement status for a workload.
|
2514
|
+
# @return [String]
|
2515
|
+
#
|
2516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadInput AWS API Documentation
|
2517
|
+
#
|
2518
|
+
class UpdateWorkloadInput < Struct.new(
|
2519
|
+
:workload_id,
|
2520
|
+
:workload_name,
|
2521
|
+
:description,
|
2522
|
+
:environment,
|
2523
|
+
:account_ids,
|
2524
|
+
:aws_regions,
|
2525
|
+
:non_aws_regions,
|
2526
|
+
:pillar_priorities,
|
2527
|
+
:architectural_design,
|
2528
|
+
:review_owner,
|
2529
|
+
:is_review_owner_update_acknowledged,
|
2530
|
+
:industry_type,
|
2531
|
+
:industry,
|
2532
|
+
:notes,
|
2533
|
+
:improvement_status)
|
2534
|
+
SENSITIVE = []
|
2535
|
+
include Aws::Structure
|
2536
|
+
end
|
2537
|
+
|
2538
|
+
# Output of an update workload call.
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] workload
|
2541
|
+
# A workload return object.
|
2542
|
+
# @return [Types::Workload]
|
2543
|
+
#
|
2544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadOutput AWS API Documentation
|
2545
|
+
#
|
2546
|
+
class UpdateWorkloadOutput < Struct.new(
|
2547
|
+
:workload)
|
2548
|
+
SENSITIVE = []
|
2549
|
+
include Aws::Structure
|
2550
|
+
end
|
2551
|
+
|
2552
|
+
# Input for Update Workload Share
|
2553
|
+
#
|
2554
|
+
# @note When making an API call, you may pass UpdateWorkloadShareInput
|
2555
|
+
# data as a hash:
|
2556
|
+
#
|
2557
|
+
# {
|
2558
|
+
# share_id: "ShareId", # required
|
2559
|
+
# workload_id: "WorkloadId", # required
|
2560
|
+
# permission_type: "READONLY", # required, accepts READONLY, CONTRIBUTOR
|
2561
|
+
# }
|
2562
|
+
#
|
2563
|
+
# @!attribute [rw] share_id
|
2564
|
+
# The ID associated with the workload share.
|
2565
|
+
# @return [String]
|
2566
|
+
#
|
2567
|
+
# @!attribute [rw] workload_id
|
2568
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2569
|
+
# Region.
|
2570
|
+
# @return [String]
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] permission_type
|
2573
|
+
# Permission granted on a workload share.
|
2574
|
+
# @return [String]
|
2575
|
+
#
|
2576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShareInput AWS API Documentation
|
2577
|
+
#
|
2578
|
+
class UpdateWorkloadShareInput < Struct.new(
|
2579
|
+
:share_id,
|
2580
|
+
:workload_id,
|
2581
|
+
:permission_type)
|
2582
|
+
SENSITIVE = []
|
2583
|
+
include Aws::Structure
|
2584
|
+
end
|
2585
|
+
|
2586
|
+
# Input for Update Workload Share
|
2587
|
+
#
|
2588
|
+
# @!attribute [rw] workload_id
|
2589
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2590
|
+
# Region.
|
2591
|
+
# @return [String]
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] workload_share
|
2594
|
+
# A workload share return object.
|
2595
|
+
# @return [Types::WorkloadShare]
|
2596
|
+
#
|
2597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShareOutput AWS API Documentation
|
2598
|
+
#
|
2599
|
+
class UpdateWorkloadShareOutput < Struct.new(
|
2600
|
+
:workload_id,
|
2601
|
+
:workload_share)
|
2602
|
+
SENSITIVE = []
|
2603
|
+
include Aws::Structure
|
2604
|
+
end
|
2605
|
+
|
2606
|
+
# @note When making an API call, you may pass UpgradeLensReviewInput
|
2607
|
+
# data as a hash:
|
2608
|
+
#
|
2609
|
+
# {
|
2610
|
+
# workload_id: "WorkloadId", # required
|
2611
|
+
# lens_alias: "LensAlias", # required
|
2612
|
+
# milestone_name: "MilestoneName", # required
|
2613
|
+
# client_request_token: "ClientRequestToken",
|
2614
|
+
# }
|
2615
|
+
#
|
2616
|
+
# @!attribute [rw] workload_id
|
2617
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2618
|
+
# Region.
|
2619
|
+
# @return [String]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] lens_alias
|
2622
|
+
# The alias of the lens, for example, `serverless`.
|
2623
|
+
#
|
2624
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2625
|
+
# @return [String]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] milestone_name
|
2628
|
+
# The name of the milestone in a workload.
|
2629
|
+
#
|
2630
|
+
# Milestone names must be unique within a workload.
|
2631
|
+
# @return [String]
|
2632
|
+
#
|
2633
|
+
# @!attribute [rw] client_request_token
|
2634
|
+
# A unique case-sensitive string used to ensure that this request is
|
2635
|
+
# idempotent (executes only once).
|
2636
|
+
#
|
2637
|
+
# You should not reuse the same token for other requests. If you retry
|
2638
|
+
# a request with the same client request token and the same parameters
|
2639
|
+
# after it has completed successfully, the result of the original
|
2640
|
+
# request is returned.
|
2641
|
+
#
|
2642
|
+
# This token is listed as required, however, if you do not specify it,
|
2643
|
+
# the AWS SDKs automatically generate one for you. If you are not
|
2644
|
+
# using the AWS SDK or the AWS CLI, you must provide this token or the
|
2645
|
+
# request will fail.
|
2646
|
+
# @return [String]
|
2647
|
+
#
|
2648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeLensReviewInput AWS API Documentation
|
2649
|
+
#
|
2650
|
+
class UpgradeLensReviewInput < Struct.new(
|
2651
|
+
:workload_id,
|
2652
|
+
:lens_alias,
|
2653
|
+
:milestone_name,
|
2654
|
+
:client_request_token)
|
2655
|
+
SENSITIVE = []
|
2656
|
+
include Aws::Structure
|
2657
|
+
end
|
2658
|
+
|
2659
|
+
# The user input is not valid.
|
2660
|
+
#
|
2661
|
+
# @!attribute [rw] message
|
2662
|
+
# Description of the error.
|
2663
|
+
# @return [String]
|
2664
|
+
#
|
2665
|
+
# @!attribute [rw] reason
|
2666
|
+
# The reason why the request failed validation.
|
2667
|
+
# @return [String]
|
2668
|
+
#
|
2669
|
+
# @!attribute [rw] fields
|
2670
|
+
# The fields that caused the error, if applicable.
|
2671
|
+
# @return [Array<Types::ValidationExceptionField>]
|
2672
|
+
#
|
2673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ValidationException AWS API Documentation
|
2674
|
+
#
|
2675
|
+
class ValidationException < Struct.new(
|
2676
|
+
:message,
|
2677
|
+
:reason,
|
2678
|
+
:fields)
|
2679
|
+
SENSITIVE = []
|
2680
|
+
include Aws::Structure
|
2681
|
+
end
|
2682
|
+
|
2683
|
+
# Stores information about a field passed inside a request that resulted
|
2684
|
+
# in an exception.
|
2685
|
+
#
|
2686
|
+
# @!attribute [rw] name
|
2687
|
+
# The field name for which validation failed.
|
2688
|
+
# @return [String]
|
2689
|
+
#
|
2690
|
+
# @!attribute [rw] message
|
2691
|
+
# Description of the error.
|
2692
|
+
# @return [String]
|
2693
|
+
#
|
2694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ValidationExceptionField AWS API Documentation
|
2695
|
+
#
|
2696
|
+
class ValidationExceptionField < Struct.new(
|
2697
|
+
:name,
|
2698
|
+
:message)
|
2699
|
+
SENSITIVE = []
|
2700
|
+
include Aws::Structure
|
2701
|
+
end
|
2702
|
+
|
2703
|
+
# The differences between the base and latest versions of the lens.
|
2704
|
+
#
|
2705
|
+
# @!attribute [rw] pillar_differences
|
2706
|
+
# The differences between the base and latest versions of the lens.
|
2707
|
+
# @return [Array<Types::PillarDifference>]
|
2708
|
+
#
|
2709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/VersionDifferences AWS API Documentation
|
2710
|
+
#
|
2711
|
+
class VersionDifferences < Struct.new(
|
2712
|
+
:pillar_differences)
|
2713
|
+
SENSITIVE = []
|
2714
|
+
include Aws::Structure
|
2715
|
+
end
|
2716
|
+
|
2717
|
+
# A workload return object.
|
2718
|
+
#
|
2719
|
+
# @!attribute [rw] workload_id
|
2720
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2721
|
+
# Region.
|
2722
|
+
# @return [String]
|
2723
|
+
#
|
2724
|
+
# @!attribute [rw] workload_arn
|
2725
|
+
# The ARN for the workload.
|
2726
|
+
# @return [String]
|
2727
|
+
#
|
2728
|
+
# @!attribute [rw] workload_name
|
2729
|
+
# The name of the workload.
|
2730
|
+
#
|
2731
|
+
# The name must be unique within an account within a Region. Spaces
|
2732
|
+
# and capitalization are ignored when checking for uniqueness.
|
2733
|
+
# @return [String]
|
2734
|
+
#
|
2735
|
+
# @!attribute [rw] description
|
2736
|
+
# The description for the workload.
|
2737
|
+
# @return [String]
|
2738
|
+
#
|
2739
|
+
# @!attribute [rw] environment
|
2740
|
+
# The environment for the workload.
|
2741
|
+
# @return [String]
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] updated_at
|
2744
|
+
# The date and time recorded.
|
2745
|
+
# @return [Time]
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] account_ids
|
2748
|
+
# The list of AWS account IDs associated with the workload.
|
2749
|
+
# @return [Array<String>]
|
2750
|
+
#
|
2751
|
+
# @!attribute [rw] aws_regions
|
2752
|
+
# The list of AWS Regions associated with the workload, for example,
|
2753
|
+
# `us-east-2`, or `ca-central-1`.
|
2754
|
+
# @return [Array<String>]
|
2755
|
+
#
|
2756
|
+
# @!attribute [rw] non_aws_regions
|
2757
|
+
# The list of non-AWS Regions associated with the workload.
|
2758
|
+
# @return [Array<String>]
|
2759
|
+
#
|
2760
|
+
# @!attribute [rw] architectural_design
|
2761
|
+
# The URL of the architectural design for the workload.
|
2762
|
+
# @return [String]
|
2763
|
+
#
|
2764
|
+
# @!attribute [rw] review_owner
|
2765
|
+
# The review owner of the workload. The name, email address, or
|
2766
|
+
# identifier for the primary group or individual that owns the
|
2767
|
+
# workload review process.
|
2768
|
+
# @return [String]
|
2769
|
+
#
|
2770
|
+
# @!attribute [rw] review_restriction_date
|
2771
|
+
# The date and time recorded.
|
2772
|
+
# @return [Time]
|
2773
|
+
#
|
2774
|
+
# @!attribute [rw] is_review_owner_update_acknowledged
|
2775
|
+
# Flag indicating whether the workload owner has acknowledged that the
|
2776
|
+
# *Review owner* field is required.
|
2777
|
+
#
|
2778
|
+
# If a **Review owner** is not added to the workload within 60 days of
|
2779
|
+
# acknowledgement, access to the workload is restricted until an owner
|
2780
|
+
# is added.
|
2781
|
+
# @return [Boolean]
|
2782
|
+
#
|
2783
|
+
# @!attribute [rw] industry_type
|
2784
|
+
# The industry type for the workload.
|
2785
|
+
#
|
2786
|
+
# If specified, must be one of the following:
|
2787
|
+
#
|
2788
|
+
# * `Agriculture`
|
2789
|
+
#
|
2790
|
+
# * `Automobile`
|
2791
|
+
#
|
2792
|
+
# * `Defense`
|
2793
|
+
#
|
2794
|
+
# * `Design and Engineering`
|
2795
|
+
#
|
2796
|
+
# * `Digital Advertising`
|
2797
|
+
#
|
2798
|
+
# * `Education`
|
2799
|
+
#
|
2800
|
+
# * `Environmental Protection`
|
2801
|
+
#
|
2802
|
+
# * `Financial Services`
|
2803
|
+
#
|
2804
|
+
# * `Gaming`
|
2805
|
+
#
|
2806
|
+
# * `General Public Services`
|
2807
|
+
#
|
2808
|
+
# * `Healthcare`
|
2809
|
+
#
|
2810
|
+
# * `Hospitality`
|
2811
|
+
#
|
2812
|
+
# * `InfoTech`
|
2813
|
+
#
|
2814
|
+
# * `Justice and Public Safety`
|
2815
|
+
#
|
2816
|
+
# * `Life Sciences`
|
2817
|
+
#
|
2818
|
+
# * `Manufacturing`
|
2819
|
+
#
|
2820
|
+
# * `Media & Entertainment`
|
2821
|
+
#
|
2822
|
+
# * `Mining & Resources`
|
2823
|
+
#
|
2824
|
+
# * `Oil & Gas`
|
2825
|
+
#
|
2826
|
+
# * `Power & Utilities`
|
2827
|
+
#
|
2828
|
+
# * `Professional Services`
|
2829
|
+
#
|
2830
|
+
# * `Real Estate & Construction`
|
2831
|
+
#
|
2832
|
+
# * `Retail & Wholesale`
|
2833
|
+
#
|
2834
|
+
# * `Social Protection`
|
2835
|
+
#
|
2836
|
+
# * `Telecommunications`
|
2837
|
+
#
|
2838
|
+
# * `Travel, Transportation & Logistics`
|
2839
|
+
#
|
2840
|
+
# * `Other`
|
2841
|
+
# @return [String]
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] industry
|
2844
|
+
# The industry for the workload.
|
2845
|
+
# @return [String]
|
2846
|
+
#
|
2847
|
+
# @!attribute [rw] notes
|
2848
|
+
# The notes associated with the workload.
|
2849
|
+
# @return [String]
|
2850
|
+
#
|
2851
|
+
# @!attribute [rw] improvement_status
|
2852
|
+
# The improvement status for a workload.
|
2853
|
+
# @return [String]
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] risk_counts
|
2856
|
+
# A map from risk names to the count of how questions have that
|
2857
|
+
# rating.
|
2858
|
+
# @return [Hash<String,Integer>]
|
2859
|
+
#
|
2860
|
+
# @!attribute [rw] pillar_priorities
|
2861
|
+
# The priorities of the pillars, which are used to order items in the
|
2862
|
+
# improvement plan. Each pillar is represented by its
|
2863
|
+
# PillarReviewSummary$PillarId.
|
2864
|
+
# @return [Array<String>]
|
2865
|
+
#
|
2866
|
+
# @!attribute [rw] lenses
|
2867
|
+
# The list of lenses associated with the workload. Each lens is
|
2868
|
+
# identified by its LensSummary$LensAlias.
|
2869
|
+
# @return [Array<String>]
|
2870
|
+
#
|
2871
|
+
# @!attribute [rw] owner
|
2872
|
+
# An AWS account ID.
|
2873
|
+
# @return [String]
|
2874
|
+
#
|
2875
|
+
# @!attribute [rw] share_invitation_id
|
2876
|
+
# The ID assigned to the share invitation.
|
2877
|
+
# @return [String]
|
2878
|
+
#
|
2879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Workload AWS API Documentation
|
2880
|
+
#
|
2881
|
+
class Workload < Struct.new(
|
2882
|
+
:workload_id,
|
2883
|
+
:workload_arn,
|
2884
|
+
:workload_name,
|
2885
|
+
:description,
|
2886
|
+
:environment,
|
2887
|
+
:updated_at,
|
2888
|
+
:account_ids,
|
2889
|
+
:aws_regions,
|
2890
|
+
:non_aws_regions,
|
2891
|
+
:architectural_design,
|
2892
|
+
:review_owner,
|
2893
|
+
:review_restriction_date,
|
2894
|
+
:is_review_owner_update_acknowledged,
|
2895
|
+
:industry_type,
|
2896
|
+
:industry,
|
2897
|
+
:notes,
|
2898
|
+
:improvement_status,
|
2899
|
+
:risk_counts,
|
2900
|
+
:pillar_priorities,
|
2901
|
+
:lenses,
|
2902
|
+
:owner,
|
2903
|
+
:share_invitation_id)
|
2904
|
+
SENSITIVE = []
|
2905
|
+
include Aws::Structure
|
2906
|
+
end
|
2907
|
+
|
2908
|
+
# A workload share return object.
|
2909
|
+
#
|
2910
|
+
# @!attribute [rw] share_id
|
2911
|
+
# The ID associated with the workload share.
|
2912
|
+
# @return [String]
|
2913
|
+
#
|
2914
|
+
# @!attribute [rw] shared_by
|
2915
|
+
# An AWS account ID.
|
2916
|
+
# @return [String]
|
2917
|
+
#
|
2918
|
+
# @!attribute [rw] shared_with
|
2919
|
+
# The AWS account ID or IAM role with which the workload is shared.
|
2920
|
+
# @return [String]
|
2921
|
+
#
|
2922
|
+
# @!attribute [rw] permission_type
|
2923
|
+
# Permission granted on a workload share.
|
2924
|
+
# @return [String]
|
2925
|
+
#
|
2926
|
+
# @!attribute [rw] status
|
2927
|
+
# The status of a workload share.
|
2928
|
+
# @return [String]
|
2929
|
+
#
|
2930
|
+
# @!attribute [rw] workload_name
|
2931
|
+
# The name of the workload.
|
2932
|
+
#
|
2933
|
+
# The name must be unique within an account within a Region. Spaces
|
2934
|
+
# and capitalization are ignored when checking for uniqueness.
|
2935
|
+
# @return [String]
|
2936
|
+
#
|
2937
|
+
# @!attribute [rw] workload_id
|
2938
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2939
|
+
# Region.
|
2940
|
+
# @return [String]
|
2941
|
+
#
|
2942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadShare AWS API Documentation
|
2943
|
+
#
|
2944
|
+
class WorkloadShare < Struct.new(
|
2945
|
+
:share_id,
|
2946
|
+
:shared_by,
|
2947
|
+
:shared_with,
|
2948
|
+
:permission_type,
|
2949
|
+
:status,
|
2950
|
+
:workload_name,
|
2951
|
+
:workload_id)
|
2952
|
+
SENSITIVE = []
|
2953
|
+
include Aws::Structure
|
2954
|
+
end
|
2955
|
+
|
2956
|
+
# A workload share summary return object.
|
2957
|
+
#
|
2958
|
+
# @!attribute [rw] share_id
|
2959
|
+
# The ID associated with the workload share.
|
2960
|
+
# @return [String]
|
2961
|
+
#
|
2962
|
+
# @!attribute [rw] shared_with
|
2963
|
+
# The AWS account ID or IAM role with which the workload is shared.
|
2964
|
+
# @return [String]
|
2965
|
+
#
|
2966
|
+
# @!attribute [rw] permission_type
|
2967
|
+
# Permission granted on a workload share.
|
2968
|
+
# @return [String]
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] status
|
2971
|
+
# The status of a workload share.
|
2972
|
+
# @return [String]
|
2973
|
+
#
|
2974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadShareSummary AWS API Documentation
|
2975
|
+
#
|
2976
|
+
class WorkloadShareSummary < Struct.new(
|
2977
|
+
:share_id,
|
2978
|
+
:shared_with,
|
2979
|
+
:permission_type,
|
2980
|
+
:status)
|
2981
|
+
SENSITIVE = []
|
2982
|
+
include Aws::Structure
|
2983
|
+
end
|
2984
|
+
|
2985
|
+
# A workload summary return object.
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] workload_id
|
2988
|
+
# The ID assigned to the workload. This ID is unique within an AWS
|
2989
|
+
# Region.
|
2990
|
+
# @return [String]
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] workload_arn
|
2993
|
+
# The ARN for the workload.
|
2994
|
+
# @return [String]
|
2995
|
+
#
|
2996
|
+
# @!attribute [rw] workload_name
|
2997
|
+
# The name of the workload.
|
2998
|
+
#
|
2999
|
+
# The name must be unique within an account within a Region. Spaces
|
3000
|
+
# and capitalization are ignored when checking for uniqueness.
|
3001
|
+
# @return [String]
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] owner
|
3004
|
+
# An AWS account ID.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
3007
|
+
# @!attribute [rw] updated_at
|
3008
|
+
# The date and time recorded.
|
3009
|
+
# @return [Time]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] lenses
|
3012
|
+
# The list of lenses associated with the workload. Each lens is
|
3013
|
+
# identified by its LensSummary$LensAlias.
|
3014
|
+
# @return [Array<String>]
|
3015
|
+
#
|
3016
|
+
# @!attribute [rw] risk_counts
|
3017
|
+
# A map from risk names to the count of how questions have that
|
3018
|
+
# rating.
|
3019
|
+
# @return [Hash<String,Integer>]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] improvement_status
|
3022
|
+
# The improvement status for a workload.
|
3023
|
+
# @return [String]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadSummary AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class WorkloadSummary < Struct.new(
|
3028
|
+
:workload_id,
|
3029
|
+
:workload_arn,
|
3030
|
+
:workload_name,
|
3031
|
+
:owner,
|
3032
|
+
:updated_at,
|
3033
|
+
:lenses,
|
3034
|
+
:risk_counts,
|
3035
|
+
:improvement_status)
|
3036
|
+
SENSITIVE = []
|
3037
|
+
include Aws::Structure
|
3038
|
+
end
|
3039
|
+
|
3040
|
+
end
|
3041
|
+
end
|