aws-sdk-controltower 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/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-controltower/client.rb +541 -0
- data/lib/aws-sdk-controltower/client_api.rb +191 -0
- data/lib/aws-sdk-controltower/customizations.rb +0 -0
- data/lib/aws-sdk-controltower/errors.rb +177 -0
- data/lib/aws-sdk-controltower/resource.rb +26 -0
- data/lib/aws-sdk-controltower/types.rb +335 -0
- data/lib/aws-sdk-controltower.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,335 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ControlTower
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# User does not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Updating or deleting a resource can cause an inconsistent state.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] message
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ConflictException AWS API Documentation
|
32
|
+
#
|
33
|
+
class ConflictException < Struct.new(
|
34
|
+
:message)
|
35
|
+
SENSITIVE = []
|
36
|
+
include Aws::Structure
|
37
|
+
end
|
38
|
+
|
39
|
+
# An operation performed by the control.
|
40
|
+
#
|
41
|
+
# @!attribute [rw] end_time
|
42
|
+
# The time that the operation finished.
|
43
|
+
# @return [Time]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] operation_type
|
46
|
+
# One of `ENABLE_CONTROL` or `DISABLE_CONTROL`.
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] start_time
|
50
|
+
# The time that the operation began.
|
51
|
+
# @return [Time]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] status
|
54
|
+
# One of `IN_PROGRESS`, `SUCEEDED`, or `FAILED`.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] status_message
|
58
|
+
# If the operation result is `FAILED`, this string contains a message
|
59
|
+
# explaining why the operation failed.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ControlOperation AWS API Documentation
|
63
|
+
#
|
64
|
+
class ControlOperation < Struct.new(
|
65
|
+
:end_time,
|
66
|
+
:operation_type,
|
67
|
+
:start_time,
|
68
|
+
:status,
|
69
|
+
:status_message)
|
70
|
+
SENSITIVE = []
|
71
|
+
include Aws::Structure
|
72
|
+
end
|
73
|
+
|
74
|
+
# @note When making an API call, you may pass DisableControlInput
|
75
|
+
# data as a hash:
|
76
|
+
#
|
77
|
+
# {
|
78
|
+
# control_identifier: "ControlIdentifier", # required
|
79
|
+
# target_identifier: "TargetIdentifier", # required
|
80
|
+
# }
|
81
|
+
#
|
82
|
+
# @!attribute [rw] control_identifier
|
83
|
+
# The ARN of the control. Only **Strongly recommended** and
|
84
|
+
# **Elective** controls are permitted, with the exception of the
|
85
|
+
# **Region deny** guardrail.
|
86
|
+
# @return [String]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] target_identifier
|
89
|
+
# The ARN of the organizational unit.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControlInput AWS API Documentation
|
93
|
+
#
|
94
|
+
class DisableControlInput < Struct.new(
|
95
|
+
:control_identifier,
|
96
|
+
:target_identifier)
|
97
|
+
SENSITIVE = []
|
98
|
+
include Aws::Structure
|
99
|
+
end
|
100
|
+
|
101
|
+
# @!attribute [rw] operation_identifier
|
102
|
+
# The ID of the asynchronous operation, which is used to track status.
|
103
|
+
# The operation is available for 90 days.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControlOutput AWS API Documentation
|
107
|
+
#
|
108
|
+
class DisableControlOutput < Struct.new(
|
109
|
+
:operation_identifier)
|
110
|
+
SENSITIVE = []
|
111
|
+
include Aws::Structure
|
112
|
+
end
|
113
|
+
|
114
|
+
# @note When making an API call, you may pass EnableControlInput
|
115
|
+
# data as a hash:
|
116
|
+
#
|
117
|
+
# {
|
118
|
+
# control_identifier: "ControlIdentifier", # required
|
119
|
+
# target_identifier: "TargetIdentifier", # required
|
120
|
+
# }
|
121
|
+
#
|
122
|
+
# @!attribute [rw] control_identifier
|
123
|
+
# The ARN of the control. Only **Strongly recommended** and
|
124
|
+
# **Elective** controls are permitted, with the exception of the
|
125
|
+
# **Region deny** guardrail.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] target_identifier
|
129
|
+
# The ARN of the organizational unit.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlInput AWS API Documentation
|
133
|
+
#
|
134
|
+
class EnableControlInput < Struct.new(
|
135
|
+
:control_identifier,
|
136
|
+
:target_identifier)
|
137
|
+
SENSITIVE = []
|
138
|
+
include Aws::Structure
|
139
|
+
end
|
140
|
+
|
141
|
+
# @!attribute [rw] operation_identifier
|
142
|
+
# The ID of the asynchronous operation, which is used to track status.
|
143
|
+
# The operation is available for 90 days.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlOutput AWS API Documentation
|
147
|
+
#
|
148
|
+
class EnableControlOutput < Struct.new(
|
149
|
+
:operation_identifier)
|
150
|
+
SENSITIVE = []
|
151
|
+
include Aws::Structure
|
152
|
+
end
|
153
|
+
|
154
|
+
# A summary of enabled controls.
|
155
|
+
#
|
156
|
+
# @!attribute [rw] control_identifier
|
157
|
+
# The ARN of the control. Only **Strongly recommended** and
|
158
|
+
# **Elective** controls are permitted, with the exception of the
|
159
|
+
# **Region deny** guardrail.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlSummary AWS API Documentation
|
163
|
+
#
|
164
|
+
class EnabledControlSummary < Struct.new(
|
165
|
+
:control_identifier)
|
166
|
+
SENSITIVE = []
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
170
|
+
# @note When making an API call, you may pass GetControlOperationInput
|
171
|
+
# data as a hash:
|
172
|
+
#
|
173
|
+
# {
|
174
|
+
# operation_identifier: "OperationIdentifier", # required
|
175
|
+
# }
|
176
|
+
#
|
177
|
+
# @!attribute [rw] operation_identifier
|
178
|
+
# The ID of the asynchronous operation, which is used to track status.
|
179
|
+
# The operation is available for 90 days.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperationInput AWS API Documentation
|
183
|
+
#
|
184
|
+
class GetControlOperationInput < Struct.new(
|
185
|
+
:operation_identifier)
|
186
|
+
SENSITIVE = []
|
187
|
+
include Aws::Structure
|
188
|
+
end
|
189
|
+
|
190
|
+
# @!attribute [rw] control_operation
|
191
|
+
# @return [Types::ControlOperation]
|
192
|
+
#
|
193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperationOutput AWS API Documentation
|
194
|
+
#
|
195
|
+
class GetControlOperationOutput < Struct.new(
|
196
|
+
:control_operation)
|
197
|
+
SENSITIVE = []
|
198
|
+
include Aws::Structure
|
199
|
+
end
|
200
|
+
|
201
|
+
# Unexpected error during processing of request.
|
202
|
+
#
|
203
|
+
# @!attribute [rw] message
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/InternalServerException AWS API Documentation
|
207
|
+
#
|
208
|
+
class InternalServerException < Struct.new(
|
209
|
+
:message)
|
210
|
+
SENSITIVE = []
|
211
|
+
include Aws::Structure
|
212
|
+
end
|
213
|
+
|
214
|
+
# @note When making an API call, you may pass ListEnabledControlsInput
|
215
|
+
# data as a hash:
|
216
|
+
#
|
217
|
+
# {
|
218
|
+
# max_results: 1,
|
219
|
+
# next_token: "String",
|
220
|
+
# target_identifier: "TargetIdentifier", # required
|
221
|
+
# }
|
222
|
+
#
|
223
|
+
# @!attribute [rw] max_results
|
224
|
+
# How many results to return per API call.
|
225
|
+
# @return [Integer]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] next_token
|
228
|
+
# The token to continue the list from a previous API call with the
|
229
|
+
# same parameters.
|
230
|
+
# @return [String]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] target_identifier
|
233
|
+
# The ARN of the organizational unit.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsInput AWS API Documentation
|
237
|
+
#
|
238
|
+
class ListEnabledControlsInput < Struct.new(
|
239
|
+
:max_results,
|
240
|
+
:next_token,
|
241
|
+
:target_identifier)
|
242
|
+
SENSITIVE = []
|
243
|
+
include Aws::Structure
|
244
|
+
end
|
245
|
+
|
246
|
+
# @!attribute [rw] enabled_controls
|
247
|
+
# Lists the controls enabled by AWS Control Tower on the specified
|
248
|
+
# organizational unit and the accounts it contains.
|
249
|
+
# @return [Array<Types::EnabledControlSummary>]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] next_token
|
252
|
+
# Retrieves the next page of results. If the string is empty, the
|
253
|
+
# current response is the end of the results.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsOutput AWS API Documentation
|
257
|
+
#
|
258
|
+
class ListEnabledControlsOutput < Struct.new(
|
259
|
+
:enabled_controls,
|
260
|
+
:next_token)
|
261
|
+
SENSITIVE = []
|
262
|
+
include Aws::Structure
|
263
|
+
end
|
264
|
+
|
265
|
+
# Request references a resource which does not exist.
|
266
|
+
#
|
267
|
+
# @!attribute [rw] message
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResourceNotFoundException AWS API Documentation
|
271
|
+
#
|
272
|
+
class ResourceNotFoundException < Struct.new(
|
273
|
+
:message)
|
274
|
+
SENSITIVE = []
|
275
|
+
include Aws::Structure
|
276
|
+
end
|
277
|
+
|
278
|
+
# Request would cause a service quota to be exceeded. The limit is 10
|
279
|
+
# concurrent operations.
|
280
|
+
#
|
281
|
+
# @!attribute [rw] message
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
285
|
+
#
|
286
|
+
class ServiceQuotaExceededException < Struct.new(
|
287
|
+
:message)
|
288
|
+
SENSITIVE = []
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# Request was denied due to request throttling.
|
293
|
+
#
|
294
|
+
# @!attribute [rw] message
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] quota_code
|
298
|
+
# The ID of the service quota that was exceeded.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] retry_after_seconds
|
302
|
+
# The number of seconds the caller should wait before retrying.
|
303
|
+
# @return [Integer]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] service_code
|
306
|
+
# The ID of the service that is associated with the error.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ThrottlingException AWS API Documentation
|
310
|
+
#
|
311
|
+
class ThrottlingException < Struct.new(
|
312
|
+
:message,
|
313
|
+
:quota_code,
|
314
|
+
:retry_after_seconds,
|
315
|
+
:service_code)
|
316
|
+
SENSITIVE = []
|
317
|
+
include Aws::Structure
|
318
|
+
end
|
319
|
+
|
320
|
+
# The input fails to satisfy the constraints specified by an AWS
|
321
|
+
# service.
|
322
|
+
#
|
323
|
+
# @!attribute [rw] message
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ValidationException AWS API Documentation
|
327
|
+
#
|
328
|
+
class ValidationException < Struct.new(
|
329
|
+
:message)
|
330
|
+
SENSITIVE = []
|
331
|
+
include Aws::Structure
|
332
|
+
end
|
333
|
+
|
334
|
+
end
|
335
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-controltower/types'
|
15
|
+
require_relative 'aws-sdk-controltower/client_api'
|
16
|
+
require_relative 'aws-sdk-controltower/client'
|
17
|
+
require_relative 'aws-sdk-controltower/errors'
|
18
|
+
require_relative 'aws-sdk-controltower/resource'
|
19
|
+
require_relative 'aws-sdk-controltower/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Control Tower. This module is available in the
|
22
|
+
# `aws-sdk-controltower` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# control_tower = Aws::ControlTower::Client.new
|
31
|
+
# resp = control_tower.disable_control(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Control Tower are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::ControlTower::Errors::ServiceError
|
43
|
+
# # rescues all AWS Control Tower API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::ControlTower
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
metadata
ADDED
@@ -0,0 +1,90 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aws-sdk-controltower
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Amazon Web Services
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-09-01 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aws-sdk-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3'
|
20
|
+
- - ">="
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 3.127.0
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - "~>"
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '3'
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 3.127.0
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: aws-sigv4
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.1'
|
40
|
+
type: :runtime
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.1'
|
47
|
+
description: Official AWS Ruby gem for AWS Control Tower. This gem is part of the
|
48
|
+
AWS SDK for Ruby.
|
49
|
+
email:
|
50
|
+
- aws-dr-rubygems@amazon.com
|
51
|
+
executables: []
|
52
|
+
extensions: []
|
53
|
+
extra_rdoc_files: []
|
54
|
+
files:
|
55
|
+
- CHANGELOG.md
|
56
|
+
- LICENSE.txt
|
57
|
+
- VERSION
|
58
|
+
- lib/aws-sdk-controltower.rb
|
59
|
+
- lib/aws-sdk-controltower/client.rb
|
60
|
+
- lib/aws-sdk-controltower/client_api.rb
|
61
|
+
- lib/aws-sdk-controltower/customizations.rb
|
62
|
+
- lib/aws-sdk-controltower/errors.rb
|
63
|
+
- lib/aws-sdk-controltower/resource.rb
|
64
|
+
- lib/aws-sdk-controltower/types.rb
|
65
|
+
homepage: https://github.com/aws/aws-sdk-ruby
|
66
|
+
licenses:
|
67
|
+
- Apache-2.0
|
68
|
+
metadata:
|
69
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-controltower
|
70
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-controltower/CHANGELOG.md
|
71
|
+
post_install_message:
|
72
|
+
rdoc_options: []
|
73
|
+
require_paths:
|
74
|
+
- lib
|
75
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
76
|
+
requirements:
|
77
|
+
- - ">="
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: '2.3'
|
80
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
81
|
+
requirements:
|
82
|
+
- - ">="
|
83
|
+
- !ruby/object:Gem::Version
|
84
|
+
version: '0'
|
85
|
+
requirements: []
|
86
|
+
rubygems_version: 3.1.6
|
87
|
+
signing_key:
|
88
|
+
specification_version: 4
|
89
|
+
summary: AWS SDK for Ruby - AWS Control Tower
|
90
|
+
test_files: []
|