aws-sdk-ssoadmin 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.
File without changes
@@ -0,0 +1,150 @@
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::SSOAdmin
11
+
12
+ # When SSOAdmin returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::SSOAdmin::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all SSOAdmin errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::SSOAdmin::Errors::ServiceError
20
+ # # rescues all SSOAdmin 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::SSOAdmin::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::SSOAdmin::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
+ end
73
+
74
+ class InternalServerException < ServiceError
75
+
76
+ # @param [Seahorse::Client::RequestContext] context
77
+ # @param [String] message
78
+ # @param [Aws::SSOAdmin::Types::InternalServerException] data
79
+ def initialize(context, message, data = Aws::EmptyStructure.new)
80
+ super(context, message, data)
81
+ end
82
+
83
+ # @return [String]
84
+ def message
85
+ @message || @data[:message]
86
+ end
87
+ end
88
+
89
+ class ResourceNotFoundException < ServiceError
90
+
91
+ # @param [Seahorse::Client::RequestContext] context
92
+ # @param [String] message
93
+ # @param [Aws::SSOAdmin::Types::ResourceNotFoundException] data
94
+ def initialize(context, message, data = Aws::EmptyStructure.new)
95
+ super(context, message, data)
96
+ end
97
+
98
+ # @return [String]
99
+ def message
100
+ @message || @data[:message]
101
+ end
102
+ end
103
+
104
+ class ServiceQuotaExceededException < ServiceError
105
+
106
+ # @param [Seahorse::Client::RequestContext] context
107
+ # @param [String] message
108
+ # @param [Aws::SSOAdmin::Types::ServiceQuotaExceededException] data
109
+ def initialize(context, message, data = Aws::EmptyStructure.new)
110
+ super(context, message, data)
111
+ end
112
+
113
+ # @return [String]
114
+ def message
115
+ @message || @data[:message]
116
+ end
117
+ end
118
+
119
+ class ThrottlingException < ServiceError
120
+
121
+ # @param [Seahorse::Client::RequestContext] context
122
+ # @param [String] message
123
+ # @param [Aws::SSOAdmin::Types::ThrottlingException] data
124
+ def initialize(context, message, data = Aws::EmptyStructure.new)
125
+ super(context, message, data)
126
+ end
127
+
128
+ # @return [String]
129
+ def message
130
+ @message || @data[:message]
131
+ end
132
+ end
133
+
134
+ class ValidationException < ServiceError
135
+
136
+ # @param [Seahorse::Client::RequestContext] context
137
+ # @param [String] message
138
+ # @param [Aws::SSOAdmin::Types::ValidationException] data
139
+ def initialize(context, message, data = Aws::EmptyStructure.new)
140
+ super(context, message, data)
141
+ end
142
+
143
+ # @return [String]
144
+ def message
145
+ @message || @data[:message]
146
+ end
147
+ end
148
+
149
+ end
150
+ 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::SSOAdmin
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,1829 @@
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::SSOAdmin
11
+ module Types
12
+
13
+ # You do 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/sso-admin-2020-07-20/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # The assignment that indicates a principal's limited access to a
27
+ # specified AWS account with a specified permission set.
28
+ #
29
+ # <note markdown="1"> The term *principal* here refers to a user or group that is defined in
30
+ # AWS SSO.
31
+ #
32
+ # </note>
33
+ #
34
+ # @!attribute [rw] account_id
35
+ # The identifier of the AWS account.
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] permission_set_arn
39
+ # The ARN of the permission set. For more information about ARNs, see
40
+ # [Amazon Resource Names (ARNs) and AWS Service
41
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
42
+ # *AWS General Reference*.
43
+ # @return [String]
44
+ #
45
+ # @!attribute [rw] principal_type
46
+ # The entity type for which the assignment will be created.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] principal_id
50
+ # The identifier of the principal.
51
+ # @return [String]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AccountAssignment AWS API Documentation
54
+ #
55
+ class AccountAssignment < Struct.new(
56
+ :account_id,
57
+ :permission_set_arn,
58
+ :principal_type,
59
+ :principal_id)
60
+ SENSITIVE = []
61
+ include Aws::Structure
62
+ end
63
+
64
+ # The status of the creation or deletion operation of an assignment that
65
+ # a principal needs to access an account.
66
+ #
67
+ # @!attribute [rw] status
68
+ # The status of the permission set provisioning process.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] request_id
72
+ # The identifier for tracking the request operation that is generated
73
+ # by the universally unique identifier (UUID) workflow.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] failure_reason
77
+ # The message that contains an error or exception in case of an
78
+ # operation failure.
79
+ # @return [String]
80
+ #
81
+ # @!attribute [rw] target_id
82
+ # The identifier for the chosen target.
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] target_type
86
+ # The entity type for which the assignment will be created.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] permission_set_arn
90
+ # The ARN of the permission set. For more information about ARNs, see
91
+ # [Amazon Resource Names (ARNs) and AWS Service
92
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
93
+ # *AWS General Reference*.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] principal_type
97
+ # The entity type for which the assignment will be created.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] principal_id
101
+ # The identifier of the principal.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] created_date
105
+ # The date that the permission set was created.
106
+ # @return [Time]
107
+ #
108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AccountAssignmentOperationStatus AWS API Documentation
109
+ #
110
+ class AccountAssignmentOperationStatus < Struct.new(
111
+ :status,
112
+ :request_id,
113
+ :failure_reason,
114
+ :target_id,
115
+ :target_type,
116
+ :permission_set_arn,
117
+ :principal_type,
118
+ :principal_id,
119
+ :created_date)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ end
123
+
124
+ # Provides information about the AccountAssignment creation request.
125
+ #
126
+ # @!attribute [rw] status
127
+ # The status of the permission set provisioning process.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] request_id
131
+ # The identifier for tracking the request operation that is generated
132
+ # by the universally unique identifier (UUID) workflow.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] created_date
136
+ # The date that the permission set was created.
137
+ # @return [Time]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AccountAssignmentOperationStatusMetadata AWS API Documentation
140
+ #
141
+ class AccountAssignmentOperationStatusMetadata < Struct.new(
142
+ :status,
143
+ :request_id,
144
+ :created_date)
145
+ SENSITIVE = []
146
+ include Aws::Structure
147
+ end
148
+
149
+ # @note When making an API call, you may pass AttachManagedPolicyToPermissionSetRequest
150
+ # data as a hash:
151
+ #
152
+ # {
153
+ # instance_arn: "InstanceArn", # required
154
+ # permission_set_arn: "PermissionSetArn", # required
155
+ # managed_policy_arn: "ManagedPolicyArn", # required
156
+ # }
157
+ #
158
+ # @!attribute [rw] instance_arn
159
+ # The ARN of the SSO instance under which the operation will be
160
+ # executed. For more information about ARNs, see [Amazon Resource
161
+ # Names (ARNs) and AWS Service
162
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
163
+ # *AWS General Reference*.
164
+ # @return [String]
165
+ #
166
+ # @!attribute [rw] permission_set_arn
167
+ # The ARN of the PermissionSet that the managed policy should be
168
+ # attached to.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] managed_policy_arn
172
+ # The IAM managed policy ARN to be attached to a permission set.
173
+ # @return [String]
174
+ #
175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSetRequest AWS API Documentation
176
+ #
177
+ class AttachManagedPolicyToPermissionSetRequest < Struct.new(
178
+ :instance_arn,
179
+ :permission_set_arn,
180
+ :managed_policy_arn)
181
+ SENSITIVE = []
182
+ include Aws::Structure
183
+ end
184
+
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSetResponse AWS API Documentation
186
+ #
187
+ class AttachManagedPolicyToPermissionSetResponse < Aws::EmptyStructure; end
188
+
189
+ # A structure that stores the details of the IAM managed policy.
190
+ #
191
+ # @!attribute [rw] name
192
+ # The name of the IAM managed policy.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] arn
196
+ # The ARN of the IAM managed policy. For more information about ARNs,
197
+ # see [Amazon Resource Names (ARNs) and AWS Service
198
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
199
+ # *AWS General Reference*.
200
+ # @return [String]
201
+ #
202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/AttachedManagedPolicy AWS API Documentation
203
+ #
204
+ class AttachedManagedPolicy < Struct.new(
205
+ :name,
206
+ :arn)
207
+ SENSITIVE = []
208
+ include Aws::Structure
209
+ end
210
+
211
+ # Occurs when a conflict with a previous successful write is detected.
212
+ # This generally occurs when the previous write did not have time to
213
+ # propagate to the host serving the current request. A retry (with
214
+ # appropriate backoff logic) is the recommended response to this
215
+ # exception.
216
+ #
217
+ # @!attribute [rw] message
218
+ # @return [String]
219
+ #
220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ConflictException AWS API Documentation
221
+ #
222
+ class ConflictException < Struct.new(
223
+ :message)
224
+ SENSITIVE = []
225
+ include Aws::Structure
226
+ end
227
+
228
+ # @note When making an API call, you may pass CreateAccountAssignmentRequest
229
+ # data as a hash:
230
+ #
231
+ # {
232
+ # instance_arn: "InstanceArn", # required
233
+ # target_id: "TargetId", # required
234
+ # target_type: "AWS_ACCOUNT", # required, accepts AWS_ACCOUNT
235
+ # permission_set_arn: "PermissionSetArn", # required
236
+ # principal_type: "USER", # required, accepts USER, GROUP
237
+ # principal_id: "PrincipalId", # required
238
+ # }
239
+ #
240
+ # @!attribute [rw] instance_arn
241
+ # The ARN of the SSO instance under which the operation will be
242
+ # executed. For more information about ARNs, see [Amazon Resource
243
+ # Names (ARNs) and AWS Service
244
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
245
+ # *AWS General Reference*.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] target_id
249
+ # The identifier for the chosen target.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] target_type
253
+ # The entity type for which the assignment will be created.
254
+ # @return [String]
255
+ #
256
+ # @!attribute [rw] permission_set_arn
257
+ # The ARN of the permission set that the admin wants to grant the
258
+ # principal access to.
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] principal_type
262
+ # The entity type for which the assignment will be created.
263
+ # @return [String]
264
+ #
265
+ # @!attribute [rw] principal_id
266
+ # The identifier of the principal.
267
+ # @return [String]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/CreateAccountAssignmentRequest AWS API Documentation
270
+ #
271
+ class CreateAccountAssignmentRequest < Struct.new(
272
+ :instance_arn,
273
+ :target_id,
274
+ :target_type,
275
+ :permission_set_arn,
276
+ :principal_type,
277
+ :principal_id)
278
+ SENSITIVE = []
279
+ include Aws::Structure
280
+ end
281
+
282
+ # @!attribute [rw] account_assignment_creation_status
283
+ # The status object for the account assignment creation operation.
284
+ # @return [Types::AccountAssignmentOperationStatus]
285
+ #
286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/CreateAccountAssignmentResponse AWS API Documentation
287
+ #
288
+ class CreateAccountAssignmentResponse < Struct.new(
289
+ :account_assignment_creation_status)
290
+ SENSITIVE = []
291
+ include Aws::Structure
292
+ end
293
+
294
+ # @note When making an API call, you may pass CreatePermissionSetRequest
295
+ # data as a hash:
296
+ #
297
+ # {
298
+ # name: "PermissionSetName", # required
299
+ # description: "PermissionSetDescription",
300
+ # instance_arn: "InstanceArn", # required
301
+ # session_duration: "Duration",
302
+ # relay_state: "RelayState",
303
+ # tags: [
304
+ # {
305
+ # key: "TagKey",
306
+ # value: "TagValue",
307
+ # },
308
+ # ],
309
+ # }
310
+ #
311
+ # @!attribute [rw] name
312
+ # The name of the PermissionSet.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] description
316
+ # The description of the PermissionSet.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] instance_arn
320
+ # The ARN of the SSO instance under which the operation will be
321
+ # executed. For more information about ARNs, see [Amazon Resource
322
+ # Names (ARNs) and AWS Service
323
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
324
+ # *AWS General Reference*.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] session_duration
328
+ # The length of time that the application user sessions are valid in
329
+ # the ISO-8601 standard.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] relay_state
333
+ # Used to redirect users within the application during the federation
334
+ # authentication process.
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] tags
338
+ # The tags to attach to the new PermissionSet.
339
+ # @return [Array<Types::Tag>]
340
+ #
341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/CreatePermissionSetRequest AWS API Documentation
342
+ #
343
+ class CreatePermissionSetRequest < Struct.new(
344
+ :name,
345
+ :description,
346
+ :instance_arn,
347
+ :session_duration,
348
+ :relay_state,
349
+ :tags)
350
+ SENSITIVE = []
351
+ include Aws::Structure
352
+ end
353
+
354
+ # @!attribute [rw] permission_set
355
+ # Defines the level of access on an AWS account.
356
+ # @return [Types::PermissionSet]
357
+ #
358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/CreatePermissionSetResponse AWS API Documentation
359
+ #
360
+ class CreatePermissionSetResponse < Struct.new(
361
+ :permission_set)
362
+ SENSITIVE = []
363
+ include Aws::Structure
364
+ end
365
+
366
+ # @note When making an API call, you may pass DeleteAccountAssignmentRequest
367
+ # data as a hash:
368
+ #
369
+ # {
370
+ # instance_arn: "InstanceArn", # required
371
+ # target_id: "TargetId", # required
372
+ # target_type: "AWS_ACCOUNT", # required, accepts AWS_ACCOUNT
373
+ # permission_set_arn: "PermissionSetArn", # required
374
+ # principal_type: "USER", # required, accepts USER, GROUP
375
+ # principal_id: "PrincipalId", # required
376
+ # }
377
+ #
378
+ # @!attribute [rw] instance_arn
379
+ # The ARN of the SSO instance under which the operation will be
380
+ # executed. For more information about ARNs, see [Amazon Resource
381
+ # Names (ARNs) and AWS Service
382
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
383
+ # *AWS General Reference*.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] target_id
387
+ # The identifier for the chosen target.
388
+ # @return [String]
389
+ #
390
+ # @!attribute [rw] target_type
391
+ # The entity type for which the assignment will be deleted.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] permission_set_arn
395
+ # The ARN of the permission set that will be used to remove access.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] principal_type
399
+ # The entity type for which the assignment will be deleted.
400
+ # @return [String]
401
+ #
402
+ # @!attribute [rw] principal_id
403
+ # The identifier of the principal.
404
+ # @return [String]
405
+ #
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeleteAccountAssignmentRequest AWS API Documentation
407
+ #
408
+ class DeleteAccountAssignmentRequest < Struct.new(
409
+ :instance_arn,
410
+ :target_id,
411
+ :target_type,
412
+ :permission_set_arn,
413
+ :principal_type,
414
+ :principal_id)
415
+ SENSITIVE = []
416
+ include Aws::Structure
417
+ end
418
+
419
+ # @!attribute [rw] account_assignment_deletion_status
420
+ # The status object for the account assignment deletion operation.
421
+ # @return [Types::AccountAssignmentOperationStatus]
422
+ #
423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeleteAccountAssignmentResponse AWS API Documentation
424
+ #
425
+ class DeleteAccountAssignmentResponse < Struct.new(
426
+ :account_assignment_deletion_status)
427
+ SENSITIVE = []
428
+ include Aws::Structure
429
+ end
430
+
431
+ # @note When making an API call, you may pass DeleteInlinePolicyFromPermissionSetRequest
432
+ # data as a hash:
433
+ #
434
+ # {
435
+ # instance_arn: "InstanceArn", # required
436
+ # permission_set_arn: "PermissionSetArn", # required
437
+ # }
438
+ #
439
+ # @!attribute [rw] instance_arn
440
+ # The ARN of the SSO instance under which the operation will be
441
+ # executed. For more information about ARNs, see [Amazon Resource
442
+ # Names (ARNs) and AWS Service
443
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
444
+ # *AWS General Reference*.
445
+ # @return [String]
446
+ #
447
+ # @!attribute [rw] permission_set_arn
448
+ # The ARN of the permission set that will be used to remove access.
449
+ # @return [String]
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSetRequest AWS API Documentation
452
+ #
453
+ class DeleteInlinePolicyFromPermissionSetRequest < Struct.new(
454
+ :instance_arn,
455
+ :permission_set_arn)
456
+ SENSITIVE = []
457
+ include Aws::Structure
458
+ end
459
+
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSetResponse AWS API Documentation
461
+ #
462
+ class DeleteInlinePolicyFromPermissionSetResponse < Aws::EmptyStructure; end
463
+
464
+ # @note When making an API call, you may pass DeletePermissionSetRequest
465
+ # data as a hash:
466
+ #
467
+ # {
468
+ # instance_arn: "InstanceArn", # required
469
+ # permission_set_arn: "PermissionSetArn", # required
470
+ # }
471
+ #
472
+ # @!attribute [rw] instance_arn
473
+ # The ARN of the SSO instance under which the operation will be
474
+ # executed. For more information about ARNs, see [Amazon Resource
475
+ # Names (ARNs) and AWS Service
476
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
477
+ # *AWS General Reference*.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] permission_set_arn
481
+ # The ARN of the permission set that should be deleted.
482
+ # @return [String]
483
+ #
484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeletePermissionSetRequest AWS API Documentation
485
+ #
486
+ class DeletePermissionSetRequest < Struct.new(
487
+ :instance_arn,
488
+ :permission_set_arn)
489
+ SENSITIVE = []
490
+ include Aws::Structure
491
+ end
492
+
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DeletePermissionSetResponse AWS API Documentation
494
+ #
495
+ class DeletePermissionSetResponse < Aws::EmptyStructure; end
496
+
497
+ # @note When making an API call, you may pass DescribeAccountAssignmentCreationStatusRequest
498
+ # data as a hash:
499
+ #
500
+ # {
501
+ # instance_arn: "InstanceArn", # required
502
+ # account_assignment_creation_request_id: "UUId", # required
503
+ # }
504
+ #
505
+ # @!attribute [rw] instance_arn
506
+ # The ARN of the SSO instance under which the operation will be
507
+ # executed. For more information about ARNs, see [Amazon Resource
508
+ # Names (ARNs) and AWS Service
509
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
510
+ # *AWS General Reference*.
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] account_assignment_creation_request_id
514
+ # The identifier that is used to track the request operation progress.
515
+ # @return [String]
516
+ #
517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatusRequest AWS API Documentation
518
+ #
519
+ class DescribeAccountAssignmentCreationStatusRequest < Struct.new(
520
+ :instance_arn,
521
+ :account_assignment_creation_request_id)
522
+ SENSITIVE = []
523
+ include Aws::Structure
524
+ end
525
+
526
+ # @!attribute [rw] account_assignment_creation_status
527
+ # The status object for the account assignment creation operation.
528
+ # @return [Types::AccountAssignmentOperationStatus]
529
+ #
530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatusResponse AWS API Documentation
531
+ #
532
+ class DescribeAccountAssignmentCreationStatusResponse < Struct.new(
533
+ :account_assignment_creation_status)
534
+ SENSITIVE = []
535
+ include Aws::Structure
536
+ end
537
+
538
+ # @note When making an API call, you may pass DescribeAccountAssignmentDeletionStatusRequest
539
+ # data as a hash:
540
+ #
541
+ # {
542
+ # instance_arn: "InstanceArn", # required
543
+ # account_assignment_deletion_request_id: "UUId", # required
544
+ # }
545
+ #
546
+ # @!attribute [rw] instance_arn
547
+ # The ARN of the SSO instance under which the operation will be
548
+ # executed. For more information about ARNs, see [Amazon Resource
549
+ # Names (ARNs) and AWS Service
550
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
551
+ # *AWS General Reference*.
552
+ # @return [String]
553
+ #
554
+ # @!attribute [rw] account_assignment_deletion_request_id
555
+ # The identifier that is used to track the request operation progress.
556
+ # @return [String]
557
+ #
558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatusRequest AWS API Documentation
559
+ #
560
+ class DescribeAccountAssignmentDeletionStatusRequest < Struct.new(
561
+ :instance_arn,
562
+ :account_assignment_deletion_request_id)
563
+ SENSITIVE = []
564
+ include Aws::Structure
565
+ end
566
+
567
+ # @!attribute [rw] account_assignment_deletion_status
568
+ # The status object for the account assignment deletion operation.
569
+ # @return [Types::AccountAssignmentOperationStatus]
570
+ #
571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatusResponse AWS API Documentation
572
+ #
573
+ class DescribeAccountAssignmentDeletionStatusResponse < Struct.new(
574
+ :account_assignment_deletion_status)
575
+ SENSITIVE = []
576
+ include Aws::Structure
577
+ end
578
+
579
+ # @note When making an API call, you may pass DescribePermissionSetProvisioningStatusRequest
580
+ # data as a hash:
581
+ #
582
+ # {
583
+ # instance_arn: "InstanceArn", # required
584
+ # provision_permission_set_request_id: "UUId", # required
585
+ # }
586
+ #
587
+ # @!attribute [rw] instance_arn
588
+ # The ARN of the SSO instance under which the operation will be
589
+ # executed. For more information about ARNs, see [Amazon Resource
590
+ # Names (ARNs) and AWS Service
591
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
592
+ # *AWS General Reference*.
593
+ # @return [String]
594
+ #
595
+ # @!attribute [rw] provision_permission_set_request_id
596
+ # The identifier that is provided by the ProvisionPermissionSet call
597
+ # to retrieve the current status of the provisioning workflow.
598
+ # @return [String]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatusRequest AWS API Documentation
601
+ #
602
+ class DescribePermissionSetProvisioningStatusRequest < Struct.new(
603
+ :instance_arn,
604
+ :provision_permission_set_request_id)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] permission_set_provisioning_status
610
+ # The status object for the permission set provisioning operation.
611
+ # @return [Types::PermissionSetProvisioningStatus]
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatusResponse AWS API Documentation
614
+ #
615
+ class DescribePermissionSetProvisioningStatusResponse < Struct.new(
616
+ :permission_set_provisioning_status)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @note When making an API call, you may pass DescribePermissionSetRequest
622
+ # data as a hash:
623
+ #
624
+ # {
625
+ # instance_arn: "InstanceArn", # required
626
+ # permission_set_arn: "PermissionSetArn", # required
627
+ # }
628
+ #
629
+ # @!attribute [rw] instance_arn
630
+ # The ARN of the SSO instance under which the operation will be
631
+ # executed. For more information about ARNs, see [Amazon Resource
632
+ # Names (ARNs) and AWS Service
633
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
634
+ # *AWS General Reference*.
635
+ # @return [String]
636
+ #
637
+ # @!attribute [rw] permission_set_arn
638
+ # The ARN of the permission set.
639
+ # @return [String]
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribePermissionSetRequest AWS API Documentation
642
+ #
643
+ class DescribePermissionSetRequest < Struct.new(
644
+ :instance_arn,
645
+ :permission_set_arn)
646
+ SENSITIVE = []
647
+ include Aws::Structure
648
+ end
649
+
650
+ # @!attribute [rw] permission_set
651
+ # Describes the level of access on an AWS account.
652
+ # @return [Types::PermissionSet]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribePermissionSetResponse AWS API Documentation
655
+ #
656
+ class DescribePermissionSetResponse < Struct.new(
657
+ :permission_set)
658
+ SENSITIVE = []
659
+ include Aws::Structure
660
+ end
661
+
662
+ # @note When making an API call, you may pass DetachManagedPolicyFromPermissionSetRequest
663
+ # data as a hash:
664
+ #
665
+ # {
666
+ # instance_arn: "InstanceArn", # required
667
+ # permission_set_arn: "PermissionSetArn", # required
668
+ # managed_policy_arn: "ManagedPolicyArn", # required
669
+ # }
670
+ #
671
+ # @!attribute [rw] instance_arn
672
+ # The ARN of the SSO instance under which the operation will be
673
+ # executed. For more information about ARNs, see [Amazon Resource
674
+ # Names (ARNs) and AWS Service
675
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
676
+ # *AWS General Reference*.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] permission_set_arn
680
+ # The ARN of the PermissionSet from which the policy should be
681
+ # detached.
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] managed_policy_arn
685
+ # The IAM managed policy ARN to be attached to a permission set.
686
+ # @return [String]
687
+ #
688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSetRequest AWS API Documentation
689
+ #
690
+ class DetachManagedPolicyFromPermissionSetRequest < Struct.new(
691
+ :instance_arn,
692
+ :permission_set_arn,
693
+ :managed_policy_arn)
694
+ SENSITIVE = []
695
+ include Aws::Structure
696
+ end
697
+
698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSetResponse AWS API Documentation
699
+ #
700
+ class DetachManagedPolicyFromPermissionSetResponse < Aws::EmptyStructure; end
701
+
702
+ # @note When making an API call, you may pass GetInlinePolicyForPermissionSetRequest
703
+ # data as a hash:
704
+ #
705
+ # {
706
+ # instance_arn: "InstanceArn", # required
707
+ # permission_set_arn: "PermissionSetArn", # required
708
+ # }
709
+ #
710
+ # @!attribute [rw] instance_arn
711
+ # The ARN of the SSO instance under which the operation will be
712
+ # executed. For more information about ARNs, see [Amazon Resource
713
+ # Names (ARNs) and AWS Service
714
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
715
+ # *AWS General Reference*.
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] permission_set_arn
719
+ # The ARN of the permission set.
720
+ # @return [String]
721
+ #
722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/GetInlinePolicyForPermissionSetRequest AWS API Documentation
723
+ #
724
+ class GetInlinePolicyForPermissionSetRequest < Struct.new(
725
+ :instance_arn,
726
+ :permission_set_arn)
727
+ SENSITIVE = []
728
+ include Aws::Structure
729
+ end
730
+
731
+ # @!attribute [rw] inline_policy
732
+ # The IAM inline policy that is attached to the permission set.
733
+ # @return [String]
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/GetInlinePolicyForPermissionSetResponse AWS API Documentation
736
+ #
737
+ class GetInlinePolicyForPermissionSetResponse < Struct.new(
738
+ :inline_policy)
739
+ SENSITIVE = [:inline_policy]
740
+ include Aws::Structure
741
+ end
742
+
743
+ # Provides information about the SSO instance.
744
+ #
745
+ # @!attribute [rw] instance_arn
746
+ # The ARN of the SSO instance under which the operation will be
747
+ # executed. For more information about ARNs, see [Amazon Resource
748
+ # Names (ARNs) and AWS Service
749
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
750
+ # *AWS General Reference*.
751
+ # @return [String]
752
+ #
753
+ # @!attribute [rw] identity_store_id
754
+ # The identifier of the identity store that is connected to the SSO
755
+ # instance.
756
+ # @return [String]
757
+ #
758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/InstanceMetadata AWS API Documentation
759
+ #
760
+ class InstanceMetadata < Struct.new(
761
+ :instance_arn,
762
+ :identity_store_id)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # The request processing has failed because of an unknown error,
768
+ # exception, or failure with an internal server.
769
+ #
770
+ # @!attribute [rw] message
771
+ # @return [String]
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/InternalServerException AWS API Documentation
774
+ #
775
+ class InternalServerException < Struct.new(
776
+ :message)
777
+ SENSITIVE = []
778
+ include Aws::Structure
779
+ end
780
+
781
+ # @note When making an API call, you may pass ListAccountAssignmentCreationStatusRequest
782
+ # data as a hash:
783
+ #
784
+ # {
785
+ # instance_arn: "InstanceArn", # required
786
+ # max_results: 1,
787
+ # next_token: "Token",
788
+ # filter: {
789
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, SUCCEEDED
790
+ # },
791
+ # }
792
+ #
793
+ # @!attribute [rw] instance_arn
794
+ # The ARN of the SSO instance under which the operation will be
795
+ # executed. For more information about ARNs, see [Amazon Resource
796
+ # Names (ARNs) and AWS Service
797
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
798
+ # *AWS General Reference*.
799
+ # @return [String]
800
+ #
801
+ # @!attribute [rw] max_results
802
+ # The maximum number of results to display for the assignment.
803
+ # @return [Integer]
804
+ #
805
+ # @!attribute [rw] next_token
806
+ # The pagination token for the list API. Initially the value is null.
807
+ # Use the output of previous API calls to make subsequent calls.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] filter
811
+ # Filters results based on the passed attribute value.
812
+ # @return [Types::OperationStatusFilter]
813
+ #
814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentCreationStatusRequest AWS API Documentation
815
+ #
816
+ class ListAccountAssignmentCreationStatusRequest < Struct.new(
817
+ :instance_arn,
818
+ :max_results,
819
+ :next_token,
820
+ :filter)
821
+ SENSITIVE = []
822
+ include Aws::Structure
823
+ end
824
+
825
+ # @!attribute [rw] account_assignments_creation_status
826
+ # The status object for the account assignment creation operation.
827
+ # @return [Array<Types::AccountAssignmentOperationStatusMetadata>]
828
+ #
829
+ # @!attribute [rw] next_token
830
+ # The pagination token for the list API. Initially the value is null.
831
+ # Use the output of previous API calls to make subsequent calls.
832
+ # @return [String]
833
+ #
834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentCreationStatusResponse AWS API Documentation
835
+ #
836
+ class ListAccountAssignmentCreationStatusResponse < Struct.new(
837
+ :account_assignments_creation_status,
838
+ :next_token)
839
+ SENSITIVE = []
840
+ include Aws::Structure
841
+ end
842
+
843
+ # @note When making an API call, you may pass ListAccountAssignmentDeletionStatusRequest
844
+ # data as a hash:
845
+ #
846
+ # {
847
+ # instance_arn: "InstanceArn", # required
848
+ # max_results: 1,
849
+ # next_token: "Token",
850
+ # filter: {
851
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, SUCCEEDED
852
+ # },
853
+ # }
854
+ #
855
+ # @!attribute [rw] instance_arn
856
+ # The ARN of the SSO instance under which the operation will be
857
+ # executed. For more information about ARNs, see [Amazon Resource
858
+ # Names (ARNs) and AWS Service
859
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
860
+ # *AWS General Reference*.
861
+ # @return [String]
862
+ #
863
+ # @!attribute [rw] max_results
864
+ # The maximum number of results to display for the assignment.
865
+ # @return [Integer]
866
+ #
867
+ # @!attribute [rw] next_token
868
+ # The pagination token for the list API. Initially the value is null.
869
+ # Use the output of previous API calls to make subsequent calls.
870
+ # @return [String]
871
+ #
872
+ # @!attribute [rw] filter
873
+ # Filters results based on the passed attribute value.
874
+ # @return [Types::OperationStatusFilter]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatusRequest AWS API Documentation
877
+ #
878
+ class ListAccountAssignmentDeletionStatusRequest < Struct.new(
879
+ :instance_arn,
880
+ :max_results,
881
+ :next_token,
882
+ :filter)
883
+ SENSITIVE = []
884
+ include Aws::Structure
885
+ end
886
+
887
+ # @!attribute [rw] account_assignments_deletion_status
888
+ # The status object for the account assignment deletion operation.
889
+ # @return [Array<Types::AccountAssignmentOperationStatusMetadata>]
890
+ #
891
+ # @!attribute [rw] next_token
892
+ # The pagination token for the list API. Initially the value is null.
893
+ # Use the output of previous API calls to make subsequent calls.
894
+ # @return [String]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatusResponse AWS API Documentation
897
+ #
898
+ class ListAccountAssignmentDeletionStatusResponse < Struct.new(
899
+ :account_assignments_deletion_status,
900
+ :next_token)
901
+ SENSITIVE = []
902
+ include Aws::Structure
903
+ end
904
+
905
+ # @note When making an API call, you may pass ListAccountAssignmentsRequest
906
+ # data as a hash:
907
+ #
908
+ # {
909
+ # instance_arn: "InstanceArn", # required
910
+ # account_id: "TargetId", # required
911
+ # permission_set_arn: "PermissionSetArn", # required
912
+ # max_results: 1,
913
+ # next_token: "Token",
914
+ # }
915
+ #
916
+ # @!attribute [rw] instance_arn
917
+ # The ARN of the SSO instance under which the operation will be
918
+ # executed. For more information about ARNs, see [Amazon Resource
919
+ # Names (ARNs) and AWS Service
920
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
921
+ # *AWS General Reference*.
922
+ # @return [String]
923
+ #
924
+ # @!attribute [rw] account_id
925
+ # The identifier of the AWS account from which to list the
926
+ # assignments.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] permission_set_arn
930
+ # The ARN of the permission set from which to list assignments.
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] max_results
934
+ # The maximum number of results to display for the assignment.
935
+ # @return [Integer]
936
+ #
937
+ # @!attribute [rw] next_token
938
+ # The pagination token for the list API. Initially the value is null.
939
+ # Use the output of previous API calls to make subsequent calls.
940
+ # @return [String]
941
+ #
942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentsRequest AWS API Documentation
943
+ #
944
+ class ListAccountAssignmentsRequest < Struct.new(
945
+ :instance_arn,
946
+ :account_id,
947
+ :permission_set_arn,
948
+ :max_results,
949
+ :next_token)
950
+ SENSITIVE = []
951
+ include Aws::Structure
952
+ end
953
+
954
+ # @!attribute [rw] account_assignments
955
+ # The list of assignments that match the input AWS account and
956
+ # permission set.
957
+ # @return [Array<Types::AccountAssignment>]
958
+ #
959
+ # @!attribute [rw] next_token
960
+ # The pagination token for the list API. Initially the value is null.
961
+ # Use the output of previous API calls to make subsequent calls.
962
+ # @return [String]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountAssignmentsResponse AWS API Documentation
965
+ #
966
+ class ListAccountAssignmentsResponse < Struct.new(
967
+ :account_assignments,
968
+ :next_token)
969
+ SENSITIVE = []
970
+ include Aws::Structure
971
+ end
972
+
973
+ # @note When making an API call, you may pass ListAccountsForProvisionedPermissionSetRequest
974
+ # data as a hash:
975
+ #
976
+ # {
977
+ # instance_arn: "InstanceArn", # required
978
+ # permission_set_arn: "PermissionSetArn", # required
979
+ # provisioning_status: "LATEST_PERMISSION_SET_PROVISIONED", # accepts LATEST_PERMISSION_SET_PROVISIONED, LATEST_PERMISSION_SET_NOT_PROVISIONED
980
+ # max_results: 1,
981
+ # next_token: "Token",
982
+ # }
983
+ #
984
+ # @!attribute [rw] instance_arn
985
+ # The ARN of the SSO instance under which the operation will be
986
+ # executed. For more information about ARNs, see [Amazon Resource
987
+ # Names (ARNs) and AWS Service
988
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
989
+ # *AWS General Reference*.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] permission_set_arn
993
+ # The ARN of the PermissionSet from which the associated AWS accounts
994
+ # will be listed.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] provisioning_status
998
+ # The permission set provisioning status for an AWS account.
999
+ # @return [String]
1000
+ #
1001
+ # @!attribute [rw] max_results
1002
+ # The maximum number of results to display for the PermissionSet.
1003
+ # @return [Integer]
1004
+ #
1005
+ # @!attribute [rw] next_token
1006
+ # The pagination token for the list API. Initially the value is null.
1007
+ # Use the output of previous API calls to make subsequent calls.
1008
+ # @return [String]
1009
+ #
1010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSetRequest AWS API Documentation
1011
+ #
1012
+ class ListAccountsForProvisionedPermissionSetRequest < Struct.new(
1013
+ :instance_arn,
1014
+ :permission_set_arn,
1015
+ :provisioning_status,
1016
+ :max_results,
1017
+ :next_token)
1018
+ SENSITIVE = []
1019
+ include Aws::Structure
1020
+ end
1021
+
1022
+ # @!attribute [rw] account_ids
1023
+ # The list of AWS `AccountIds`.
1024
+ # @return [Array<String>]
1025
+ #
1026
+ # @!attribute [rw] next_token
1027
+ # The pagination token for the list API. Initially the value is null.
1028
+ # Use the output of previous API calls to make subsequent calls.
1029
+ # @return [String]
1030
+ #
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSetResponse AWS API Documentation
1032
+ #
1033
+ class ListAccountsForProvisionedPermissionSetResponse < Struct.new(
1034
+ :account_ids,
1035
+ :next_token)
1036
+ SENSITIVE = []
1037
+ include Aws::Structure
1038
+ end
1039
+
1040
+ # @note When making an API call, you may pass ListInstancesRequest
1041
+ # data as a hash:
1042
+ #
1043
+ # {
1044
+ # max_results: 1,
1045
+ # next_token: "Token",
1046
+ # }
1047
+ #
1048
+ # @!attribute [rw] max_results
1049
+ # The maximum number of results to display for the instance.
1050
+ # @return [Integer]
1051
+ #
1052
+ # @!attribute [rw] next_token
1053
+ # The pagination token for the list API. Initially the value is null.
1054
+ # Use the output of previous API calls to make subsequent calls.
1055
+ # @return [String]
1056
+ #
1057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListInstancesRequest AWS API Documentation
1058
+ #
1059
+ class ListInstancesRequest < Struct.new(
1060
+ :max_results,
1061
+ :next_token)
1062
+ SENSITIVE = []
1063
+ include Aws::Structure
1064
+ end
1065
+
1066
+ # @!attribute [rw] instances
1067
+ # Lists the SSO instances that the caller has access to.
1068
+ # @return [Array<Types::InstanceMetadata>]
1069
+ #
1070
+ # @!attribute [rw] next_token
1071
+ # The pagination token for the list API. Initially the value is null.
1072
+ # Use the output of previous API calls to make subsequent calls.
1073
+ # @return [String]
1074
+ #
1075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListInstancesResponse AWS API Documentation
1076
+ #
1077
+ class ListInstancesResponse < Struct.new(
1078
+ :instances,
1079
+ :next_token)
1080
+ SENSITIVE = []
1081
+ include Aws::Structure
1082
+ end
1083
+
1084
+ # @note When making an API call, you may pass ListManagedPoliciesInPermissionSetRequest
1085
+ # data as a hash:
1086
+ #
1087
+ # {
1088
+ # instance_arn: "InstanceArn", # required
1089
+ # permission_set_arn: "PermissionSetArn", # required
1090
+ # max_results: 1,
1091
+ # next_token: "Token",
1092
+ # }
1093
+ #
1094
+ # @!attribute [rw] instance_arn
1095
+ # The ARN of the SSO instance under which the operation will be
1096
+ # executed. For more information about ARNs, see [Amazon Resource
1097
+ # Names (ARNs) and AWS Service
1098
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1099
+ # *AWS General Reference*.
1100
+ # @return [String]
1101
+ #
1102
+ # @!attribute [rw] permission_set_arn
1103
+ # The ARN of the PermissionSet whose managed policies will be listed.
1104
+ # @return [String]
1105
+ #
1106
+ # @!attribute [rw] max_results
1107
+ # The maximum number of results to display for the PermissionSet.
1108
+ # @return [Integer]
1109
+ #
1110
+ # @!attribute [rw] next_token
1111
+ # The pagination token for the list API. Initially the value is null.
1112
+ # Use the output of previous API calls to make subsequent calls.
1113
+ # @return [String]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSetRequest AWS API Documentation
1116
+ #
1117
+ class ListManagedPoliciesInPermissionSetRequest < Struct.new(
1118
+ :instance_arn,
1119
+ :permission_set_arn,
1120
+ :max_results,
1121
+ :next_token)
1122
+ SENSITIVE = []
1123
+ include Aws::Structure
1124
+ end
1125
+
1126
+ # @!attribute [rw] attached_managed_policies
1127
+ # The array of the AttachedManagedPolicy data type object.
1128
+ # @return [Array<Types::AttachedManagedPolicy>]
1129
+ #
1130
+ # @!attribute [rw] next_token
1131
+ # The pagination token for the list API. Initially the value is null.
1132
+ # Use the output of previous API calls to make subsequent calls.
1133
+ # @return [String]
1134
+ #
1135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSetResponse AWS API Documentation
1136
+ #
1137
+ class ListManagedPoliciesInPermissionSetResponse < Struct.new(
1138
+ :attached_managed_policies,
1139
+ :next_token)
1140
+ SENSITIVE = []
1141
+ include Aws::Structure
1142
+ end
1143
+
1144
+ # @note When making an API call, you may pass ListPermissionSetProvisioningStatusRequest
1145
+ # data as a hash:
1146
+ #
1147
+ # {
1148
+ # instance_arn: "InstanceArn", # required
1149
+ # max_results: 1,
1150
+ # next_token: "Token",
1151
+ # filter: {
1152
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, SUCCEEDED
1153
+ # },
1154
+ # }
1155
+ #
1156
+ # @!attribute [rw] instance_arn
1157
+ # The ARN of the SSO instance under which the operation will be
1158
+ # executed. For more information about ARNs, see [Amazon Resource
1159
+ # Names (ARNs) and AWS Service
1160
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1161
+ # *AWS General Reference*.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] max_results
1165
+ # The maximum number of results to display for the assignment.
1166
+ # @return [Integer]
1167
+ #
1168
+ # @!attribute [rw] next_token
1169
+ # The pagination token for the list API. Initially the value is null.
1170
+ # Use the output of previous API calls to make subsequent calls.
1171
+ # @return [String]
1172
+ #
1173
+ # @!attribute [rw] filter
1174
+ # Filters results based on the passed attribute value.
1175
+ # @return [Types::OperationStatusFilter]
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetProvisioningStatusRequest AWS API Documentation
1178
+ #
1179
+ class ListPermissionSetProvisioningStatusRequest < Struct.new(
1180
+ :instance_arn,
1181
+ :max_results,
1182
+ :next_token,
1183
+ :filter)
1184
+ SENSITIVE = []
1185
+ include Aws::Structure
1186
+ end
1187
+
1188
+ # @!attribute [rw] permission_sets_provisioning_status
1189
+ # The status object for the permission set provisioning operation.
1190
+ # @return [Array<Types::PermissionSetProvisioningStatusMetadata>]
1191
+ #
1192
+ # @!attribute [rw] next_token
1193
+ # The pagination token for the list API. Initially the value is null.
1194
+ # Use the output of previous API calls to make subsequent calls.
1195
+ # @return [String]
1196
+ #
1197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetProvisioningStatusResponse AWS API Documentation
1198
+ #
1199
+ class ListPermissionSetProvisioningStatusResponse < Struct.new(
1200
+ :permission_sets_provisioning_status,
1201
+ :next_token)
1202
+ SENSITIVE = []
1203
+ include Aws::Structure
1204
+ end
1205
+
1206
+ # @note When making an API call, you may pass ListPermissionSetsProvisionedToAccountRequest
1207
+ # data as a hash:
1208
+ #
1209
+ # {
1210
+ # instance_arn: "InstanceArn", # required
1211
+ # account_id: "AccountId", # required
1212
+ # provisioning_status: "LATEST_PERMISSION_SET_PROVISIONED", # accepts LATEST_PERMISSION_SET_PROVISIONED, LATEST_PERMISSION_SET_NOT_PROVISIONED
1213
+ # max_results: 1,
1214
+ # next_token: "Token",
1215
+ # }
1216
+ #
1217
+ # @!attribute [rw] instance_arn
1218
+ # The ARN of the SSO instance under which the operation will be
1219
+ # executed. For more information about ARNs, see [Amazon Resource
1220
+ # Names (ARNs) and AWS Service
1221
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1222
+ # *AWS General Reference*.
1223
+ # @return [String]
1224
+ #
1225
+ # @!attribute [rw] account_id
1226
+ # The identifier of the AWS account from which to list the
1227
+ # assignments.
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] provisioning_status
1231
+ # The status object for the permission set provisioning operation.
1232
+ # @return [String]
1233
+ #
1234
+ # @!attribute [rw] max_results
1235
+ # The maximum number of results to display for the assignment.
1236
+ # @return [Integer]
1237
+ #
1238
+ # @!attribute [rw] next_token
1239
+ # The pagination token for the list API. Initially the value is null.
1240
+ # Use the output of previous API calls to make subsequent calls.
1241
+ # @return [String]
1242
+ #
1243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccountRequest AWS API Documentation
1244
+ #
1245
+ class ListPermissionSetsProvisionedToAccountRequest < Struct.new(
1246
+ :instance_arn,
1247
+ :account_id,
1248
+ :provisioning_status,
1249
+ :max_results,
1250
+ :next_token)
1251
+ SENSITIVE = []
1252
+ include Aws::Structure
1253
+ end
1254
+
1255
+ # @!attribute [rw] next_token
1256
+ # The pagination token for the list API. Initially the value is null.
1257
+ # Use the output of previous API calls to make subsequent calls.
1258
+ # @return [String]
1259
+ #
1260
+ # @!attribute [rw] permission_sets
1261
+ # Defines the level of access that an AWS account has.
1262
+ # @return [Array<String>]
1263
+ #
1264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccountResponse AWS API Documentation
1265
+ #
1266
+ class ListPermissionSetsProvisionedToAccountResponse < Struct.new(
1267
+ :next_token,
1268
+ :permission_sets)
1269
+ SENSITIVE = []
1270
+ include Aws::Structure
1271
+ end
1272
+
1273
+ # @note When making an API call, you may pass ListPermissionSetsRequest
1274
+ # data as a hash:
1275
+ #
1276
+ # {
1277
+ # instance_arn: "InstanceArn", # required
1278
+ # next_token: "Token",
1279
+ # max_results: 1,
1280
+ # }
1281
+ #
1282
+ # @!attribute [rw] instance_arn
1283
+ # The ARN of the SSO instance under which the operation will be
1284
+ # executed. For more information about ARNs, see [Amazon Resource
1285
+ # Names (ARNs) and AWS Service
1286
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1287
+ # *AWS General Reference*.
1288
+ # @return [String]
1289
+ #
1290
+ # @!attribute [rw] next_token
1291
+ # The pagination token for the list API. Initially the value is null.
1292
+ # Use the output of previous API calls to make subsequent calls.
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] max_results
1296
+ # The maximum number of results to display for the assignment.
1297
+ # @return [Integer]
1298
+ #
1299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetsRequest AWS API Documentation
1300
+ #
1301
+ class ListPermissionSetsRequest < Struct.new(
1302
+ :instance_arn,
1303
+ :next_token,
1304
+ :max_results)
1305
+ SENSITIVE = []
1306
+ include Aws::Structure
1307
+ end
1308
+
1309
+ # @!attribute [rw] permission_sets
1310
+ # Defines the level of access on an AWS account.
1311
+ # @return [Array<String>]
1312
+ #
1313
+ # @!attribute [rw] next_token
1314
+ # The pagination token for the list API. Initially the value is null.
1315
+ # Use the output of previous API calls to make subsequent calls.
1316
+ # @return [String]
1317
+ #
1318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListPermissionSetsResponse AWS API Documentation
1319
+ #
1320
+ class ListPermissionSetsResponse < Struct.new(
1321
+ :permission_sets,
1322
+ :next_token)
1323
+ SENSITIVE = []
1324
+ include Aws::Structure
1325
+ end
1326
+
1327
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1328
+ # data as a hash:
1329
+ #
1330
+ # {
1331
+ # instance_arn: "InstanceArn", # required
1332
+ # resource_arn: "GeneralArn", # required
1333
+ # next_token: "Token",
1334
+ # }
1335
+ #
1336
+ # @!attribute [rw] instance_arn
1337
+ # The ARN of the SSO instance under which the operation will be
1338
+ # executed. For more information about ARNs, see [Amazon Resource
1339
+ # Names (ARNs) and AWS Service
1340
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1341
+ # *AWS General Reference*.
1342
+ # @return [String]
1343
+ #
1344
+ # @!attribute [rw] resource_arn
1345
+ # The ARN of the resource with the tags to be listed.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] next_token
1349
+ # The pagination token for the list API. Initially the value is null.
1350
+ # Use the output of previous API calls to make subsequent calls.
1351
+ # @return [String]
1352
+ #
1353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListTagsForResourceRequest AWS API Documentation
1354
+ #
1355
+ class ListTagsForResourceRequest < Struct.new(
1356
+ :instance_arn,
1357
+ :resource_arn,
1358
+ :next_token)
1359
+ SENSITIVE = []
1360
+ include Aws::Structure
1361
+ end
1362
+
1363
+ # @!attribute [rw] tags
1364
+ # A set of key-value pairs that are used to manage the resource.
1365
+ # @return [Array<Types::Tag>]
1366
+ #
1367
+ # @!attribute [rw] next_token
1368
+ # The pagination token for the list API. Initially the value is null.
1369
+ # Use the output of previous API calls to make subsequent calls.
1370
+ # @return [String]
1371
+ #
1372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListTagsForResourceResponse AWS API Documentation
1373
+ #
1374
+ class ListTagsForResourceResponse < Struct.new(
1375
+ :tags,
1376
+ :next_token)
1377
+ SENSITIVE = []
1378
+ include Aws::Structure
1379
+ end
1380
+
1381
+ # Filters he operation status list based on the passed attribute value.
1382
+ #
1383
+ # @note When making an API call, you may pass OperationStatusFilter
1384
+ # data as a hash:
1385
+ #
1386
+ # {
1387
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, SUCCEEDED
1388
+ # }
1389
+ #
1390
+ # @!attribute [rw] status
1391
+ # Filters the list operations result based on the status attribute.
1392
+ # @return [String]
1393
+ #
1394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/OperationStatusFilter AWS API Documentation
1395
+ #
1396
+ class OperationStatusFilter < Struct.new(
1397
+ :status)
1398
+ SENSITIVE = []
1399
+ include Aws::Structure
1400
+ end
1401
+
1402
+ # An entity that contains IAM policies.
1403
+ #
1404
+ # @!attribute [rw] name
1405
+ # The name of the permission set.
1406
+ # @return [String]
1407
+ #
1408
+ # @!attribute [rw] permission_set_arn
1409
+ # The ARN of the permission set. For more information about ARNs, see
1410
+ # [Amazon Resource Names (ARNs) and AWS Service
1411
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1412
+ # *AWS General Reference*.
1413
+ # @return [String]
1414
+ #
1415
+ # @!attribute [rw] description
1416
+ # The description of the PermissionSet.
1417
+ # @return [String]
1418
+ #
1419
+ # @!attribute [rw] created_date
1420
+ # The date that the permission set was created.
1421
+ # @return [Time]
1422
+ #
1423
+ # @!attribute [rw] session_duration
1424
+ # The length of time that the application user sessions are valid for
1425
+ # in the ISO-8601 standard.
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] relay_state
1429
+ # Used to redirect users within the application during the federation
1430
+ # authentication process.
1431
+ # @return [String]
1432
+ #
1433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/PermissionSet AWS API Documentation
1434
+ #
1435
+ class PermissionSet < Struct.new(
1436
+ :name,
1437
+ :permission_set_arn,
1438
+ :description,
1439
+ :created_date,
1440
+ :session_duration,
1441
+ :relay_state)
1442
+ SENSITIVE = []
1443
+ include Aws::Structure
1444
+ end
1445
+
1446
+ # A structure that is used to provide the status of the provisioning
1447
+ # operation for a specified permission set.
1448
+ #
1449
+ # @!attribute [rw] status
1450
+ # The status of the permission set provisioning process.
1451
+ # @return [String]
1452
+ #
1453
+ # @!attribute [rw] request_id
1454
+ # The identifier for tracking the request operation that is generated
1455
+ # by the universally unique identifier (UUID) workflow.
1456
+ # @return [String]
1457
+ #
1458
+ # @!attribute [rw] account_id
1459
+ # The identifier of the AWS account from which to list the
1460
+ # assignments.
1461
+ # @return [String]
1462
+ #
1463
+ # @!attribute [rw] permission_set_arn
1464
+ # The ARN of the permission set that is being provisioned. For more
1465
+ # information about ARNs, see [Amazon Resource Names (ARNs) and AWS
1466
+ # Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html)
1467
+ # in the *AWS General Reference*.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] failure_reason
1471
+ # The message that contains an error or exception in case of an
1472
+ # operation failure.
1473
+ # @return [String]
1474
+ #
1475
+ # @!attribute [rw] created_date
1476
+ # The date that the permission set was created.
1477
+ # @return [Time]
1478
+ #
1479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/PermissionSetProvisioningStatus AWS API Documentation
1480
+ #
1481
+ class PermissionSetProvisioningStatus < Struct.new(
1482
+ :status,
1483
+ :request_id,
1484
+ :account_id,
1485
+ :permission_set_arn,
1486
+ :failure_reason,
1487
+ :created_date)
1488
+ SENSITIVE = []
1489
+ include Aws::Structure
1490
+ end
1491
+
1492
+ # Provides information about the permission set provisioning status.
1493
+ #
1494
+ # @!attribute [rw] status
1495
+ # The status of the permission set provisioning process.
1496
+ # @return [String]
1497
+ #
1498
+ # @!attribute [rw] request_id
1499
+ # The identifier for tracking the request operation that is generated
1500
+ # by the universally unique identifier (UUID) workflow.
1501
+ # @return [String]
1502
+ #
1503
+ # @!attribute [rw] created_date
1504
+ # The date that the permission set was created.
1505
+ # @return [Time]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/PermissionSetProvisioningStatusMetadata AWS API Documentation
1508
+ #
1509
+ class PermissionSetProvisioningStatusMetadata < Struct.new(
1510
+ :status,
1511
+ :request_id,
1512
+ :created_date)
1513
+ SENSITIVE = []
1514
+ include Aws::Structure
1515
+ end
1516
+
1517
+ # @note When making an API call, you may pass ProvisionPermissionSetRequest
1518
+ # data as a hash:
1519
+ #
1520
+ # {
1521
+ # instance_arn: "InstanceArn", # required
1522
+ # permission_set_arn: "PermissionSetArn", # required
1523
+ # target_id: "TargetId",
1524
+ # target_type: "AWS_ACCOUNT", # required, accepts AWS_ACCOUNT, ALL_PROVISIONED_ACCOUNTS
1525
+ # }
1526
+ #
1527
+ # @!attribute [rw] instance_arn
1528
+ # The ARN of the SSO instance under which the operation will be
1529
+ # executed. For more information about ARNs, see [Amazon Resource
1530
+ # Names (ARNs) and AWS Service
1531
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1532
+ # *AWS General Reference*.
1533
+ # @return [String]
1534
+ #
1535
+ # @!attribute [rw] permission_set_arn
1536
+ # The ARN of the permission set.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] target_id
1540
+ # The identifier for the chosen target.
1541
+ # @return [String]
1542
+ #
1543
+ # @!attribute [rw] target_type
1544
+ # The entity type for which the assignment will be created.
1545
+ # @return [String]
1546
+ #
1547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ProvisionPermissionSetRequest AWS API Documentation
1548
+ #
1549
+ class ProvisionPermissionSetRequest < Struct.new(
1550
+ :instance_arn,
1551
+ :permission_set_arn,
1552
+ :target_id,
1553
+ :target_type)
1554
+ SENSITIVE = []
1555
+ include Aws::Structure
1556
+ end
1557
+
1558
+ # @!attribute [rw] permission_set_provisioning_status
1559
+ # The status object for the permission set provisioning operation.
1560
+ # @return [Types::PermissionSetProvisioningStatus]
1561
+ #
1562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ProvisionPermissionSetResponse AWS API Documentation
1563
+ #
1564
+ class ProvisionPermissionSetResponse < Struct.new(
1565
+ :permission_set_provisioning_status)
1566
+ SENSITIVE = []
1567
+ include Aws::Structure
1568
+ end
1569
+
1570
+ # @note When making an API call, you may pass PutInlinePolicyToPermissionSetRequest
1571
+ # data as a hash:
1572
+ #
1573
+ # {
1574
+ # instance_arn: "InstanceArn", # required
1575
+ # permission_set_arn: "PermissionSetArn", # required
1576
+ # inline_policy: "PermissionSetPolicyDocument", # required
1577
+ # }
1578
+ #
1579
+ # @!attribute [rw] instance_arn
1580
+ # The ARN of the SSO instance under which the operation will be
1581
+ # executed. For more information about ARNs, see [Amazon Resource
1582
+ # Names (ARNs) and AWS Service
1583
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1584
+ # *AWS General Reference*.
1585
+ # @return [String]
1586
+ #
1587
+ # @!attribute [rw] permission_set_arn
1588
+ # The ARN of the permission set.
1589
+ # @return [String]
1590
+ #
1591
+ # @!attribute [rw] inline_policy
1592
+ # The IAM inline policy to attach to a PermissionSet.
1593
+ # @return [String]
1594
+ #
1595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/PutInlinePolicyToPermissionSetRequest AWS API Documentation
1596
+ #
1597
+ class PutInlinePolicyToPermissionSetRequest < Struct.new(
1598
+ :instance_arn,
1599
+ :permission_set_arn,
1600
+ :inline_policy)
1601
+ SENSITIVE = [:inline_policy]
1602
+ include Aws::Structure
1603
+ end
1604
+
1605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/PutInlinePolicyToPermissionSetResponse AWS API Documentation
1606
+ #
1607
+ class PutInlinePolicyToPermissionSetResponse < Aws::EmptyStructure; end
1608
+
1609
+ # Indicates that a requested resource is not found.
1610
+ #
1611
+ # @!attribute [rw] message
1612
+ # @return [String]
1613
+ #
1614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ResourceNotFoundException AWS API Documentation
1615
+ #
1616
+ class ResourceNotFoundException < Struct.new(
1617
+ :message)
1618
+ SENSITIVE = []
1619
+ include Aws::Structure
1620
+ end
1621
+
1622
+ # Indicates that the principal has crossed the permitted number of
1623
+ # resources that can be created.
1624
+ #
1625
+ # @!attribute [rw] message
1626
+ # @return [String]
1627
+ #
1628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ServiceQuotaExceededException AWS API Documentation
1629
+ #
1630
+ class ServiceQuotaExceededException < Struct.new(
1631
+ :message)
1632
+ SENSITIVE = []
1633
+ include Aws::Structure
1634
+ end
1635
+
1636
+ # A set of key-value pairs that are used to manage the resource. Tags
1637
+ # can only be applied to permission sets and cannot be applied to
1638
+ # corresponding roles that AWS SSO creates in AWS accounts.
1639
+ #
1640
+ # @note When making an API call, you may pass Tag
1641
+ # data as a hash:
1642
+ #
1643
+ # {
1644
+ # key: "TagKey",
1645
+ # value: "TagValue",
1646
+ # }
1647
+ #
1648
+ # @!attribute [rw] key
1649
+ # The key for the tag.
1650
+ # @return [String]
1651
+ #
1652
+ # @!attribute [rw] value
1653
+ # The value of the tag.
1654
+ # @return [String]
1655
+ #
1656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/Tag AWS API Documentation
1657
+ #
1658
+ class Tag < Struct.new(
1659
+ :key,
1660
+ :value)
1661
+ SENSITIVE = []
1662
+ include Aws::Structure
1663
+ end
1664
+
1665
+ # @note When making an API call, you may pass TagResourceRequest
1666
+ # data as a hash:
1667
+ #
1668
+ # {
1669
+ # instance_arn: "InstanceArn", # required
1670
+ # resource_arn: "GeneralArn", # required
1671
+ # tags: [ # required
1672
+ # {
1673
+ # key: "TagKey",
1674
+ # value: "TagValue",
1675
+ # },
1676
+ # ],
1677
+ # }
1678
+ #
1679
+ # @!attribute [rw] instance_arn
1680
+ # The ARN of the SSO instance under which the operation will be
1681
+ # executed. For more information about ARNs, see [Amazon Resource
1682
+ # Names (ARNs) and AWS Service
1683
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1684
+ # *AWS General Reference*.
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] resource_arn
1688
+ # The ARN of the resource with the tags to be listed.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] tags
1692
+ # A set of key-value pairs that are used to manage the resource.
1693
+ # @return [Array<Types::Tag>]
1694
+ #
1695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/TagResourceRequest AWS API Documentation
1696
+ #
1697
+ class TagResourceRequest < Struct.new(
1698
+ :instance_arn,
1699
+ :resource_arn,
1700
+ :tags)
1701
+ SENSITIVE = []
1702
+ include Aws::Structure
1703
+ end
1704
+
1705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/TagResourceResponse AWS API Documentation
1706
+ #
1707
+ class TagResourceResponse < Aws::EmptyStructure; end
1708
+
1709
+ # Indicates that the principal has crossed the throttling limits of the
1710
+ # API operations.
1711
+ #
1712
+ # @!attribute [rw] message
1713
+ # @return [String]
1714
+ #
1715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ThrottlingException AWS API Documentation
1716
+ #
1717
+ class ThrottlingException < Struct.new(
1718
+ :message)
1719
+ SENSITIVE = []
1720
+ include Aws::Structure
1721
+ end
1722
+
1723
+ # @note When making an API call, you may pass UntagResourceRequest
1724
+ # data as a hash:
1725
+ #
1726
+ # {
1727
+ # instance_arn: "InstanceArn", # required
1728
+ # resource_arn: "GeneralArn", # required
1729
+ # tag_keys: ["TagKey"], # required
1730
+ # }
1731
+ #
1732
+ # @!attribute [rw] instance_arn
1733
+ # The ARN of the SSO instance under which the operation will be
1734
+ # executed. For more information about ARNs, see [Amazon Resource
1735
+ # Names (ARNs) and AWS Service
1736
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1737
+ # *AWS General Reference*.
1738
+ # @return [String]
1739
+ #
1740
+ # @!attribute [rw] resource_arn
1741
+ # The ARN of the resource with the tags to be listed.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] tag_keys
1745
+ # The keys of tags that are attached to the resource.
1746
+ # @return [Array<String>]
1747
+ #
1748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/UntagResourceRequest AWS API Documentation
1749
+ #
1750
+ class UntagResourceRequest < Struct.new(
1751
+ :instance_arn,
1752
+ :resource_arn,
1753
+ :tag_keys)
1754
+ SENSITIVE = []
1755
+ include Aws::Structure
1756
+ end
1757
+
1758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/UntagResourceResponse AWS API Documentation
1759
+ #
1760
+ class UntagResourceResponse < Aws::EmptyStructure; end
1761
+
1762
+ # @note When making an API call, you may pass UpdatePermissionSetRequest
1763
+ # data as a hash:
1764
+ #
1765
+ # {
1766
+ # instance_arn: "InstanceArn", # required
1767
+ # permission_set_arn: "PermissionSetArn", # required
1768
+ # description: "PermissionSetDescription",
1769
+ # session_duration: "Duration",
1770
+ # relay_state: "RelayState",
1771
+ # }
1772
+ #
1773
+ # @!attribute [rw] instance_arn
1774
+ # The ARN of the SSO instance under which the operation will be
1775
+ # executed. For more information about ARNs, see [Amazon Resource
1776
+ # Names (ARNs) and AWS Service
1777
+ # Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the
1778
+ # *AWS General Reference*.
1779
+ # @return [String]
1780
+ #
1781
+ # @!attribute [rw] permission_set_arn
1782
+ # The ARN of the permission set.
1783
+ # @return [String]
1784
+ #
1785
+ # @!attribute [rw] description
1786
+ # The description of the PermissionSet.
1787
+ # @return [String]
1788
+ #
1789
+ # @!attribute [rw] session_duration
1790
+ # The length of time that the application user sessions are valid for
1791
+ # in the ISO-8601 standard.
1792
+ # @return [String]
1793
+ #
1794
+ # @!attribute [rw] relay_state
1795
+ # Used to redirect users within the application during the federation
1796
+ # authentication process.
1797
+ # @return [String]
1798
+ #
1799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/UpdatePermissionSetRequest AWS API Documentation
1800
+ #
1801
+ class UpdatePermissionSetRequest < Struct.new(
1802
+ :instance_arn,
1803
+ :permission_set_arn,
1804
+ :description,
1805
+ :session_duration,
1806
+ :relay_state)
1807
+ SENSITIVE = []
1808
+ include Aws::Structure
1809
+ end
1810
+
1811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/UpdatePermissionSetResponse AWS API Documentation
1812
+ #
1813
+ class UpdatePermissionSetResponse < Aws::EmptyStructure; end
1814
+
1815
+ # The request failed because it contains a syntax error.
1816
+ #
1817
+ # @!attribute [rw] message
1818
+ # @return [String]
1819
+ #
1820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ValidationException AWS API Documentation
1821
+ #
1822
+ class ValidationException < Struct.new(
1823
+ :message)
1824
+ SENSITIVE = []
1825
+ include Aws::Structure
1826
+ end
1827
+
1828
+ end
1829
+ end