aws-sdk-ram 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RAM
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RAM
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,1143 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RAM
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AcceptResourceShareInvitationRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # resource_share_invitation_arn: "String", # required
16
+ # client_token: "String",
17
+ # }
18
+ #
19
+ # @!attribute [rw] resource_share_invitation_arn
20
+ # The Amazon Resource Name (ARN) of the invitation.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] client_token
24
+ # A unique, case-sensitive identifier that you provide to ensure the
25
+ # idempotency of the request.
26
+ # @return [String]
27
+ #
28
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AcceptResourceShareInvitationRequest AWS API Documentation
29
+ #
30
+ class AcceptResourceShareInvitationRequest < Struct.new(
31
+ :resource_share_invitation_arn,
32
+ :client_token)
33
+ include Aws::Structure
34
+ end
35
+
36
+ # @!attribute [rw] resource_share_invitation
37
+ # Information about the invitation.
38
+ # @return [Types::ResourceShareInvitation]
39
+ #
40
+ # @!attribute [rw] client_token
41
+ # A unique, case-sensitive identifier that you provide to ensure the
42
+ # idempotency of the request.
43
+ # @return [String]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AcceptResourceShareInvitationResponse AWS API Documentation
46
+ #
47
+ class AcceptResourceShareInvitationResponse < Struct.new(
48
+ :resource_share_invitation,
49
+ :client_token)
50
+ include Aws::Structure
51
+ end
52
+
53
+ # @note When making an API call, you may pass AssociateResourceShareRequest
54
+ # data as a hash:
55
+ #
56
+ # {
57
+ # resource_share_arn: "String", # required
58
+ # resource_arns: ["String"],
59
+ # principals: ["String"],
60
+ # client_token: "String",
61
+ # }
62
+ #
63
+ # @!attribute [rw] resource_share_arn
64
+ # The Amazon Resource Name (ARN) of the resource share.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] resource_arns
68
+ # The Amazon Resource Names (ARN) of the resources.
69
+ # @return [Array<String>]
70
+ #
71
+ # @!attribute [rw] principals
72
+ # The principals.
73
+ # @return [Array<String>]
74
+ #
75
+ # @!attribute [rw] client_token
76
+ # A unique, case-sensitive identifier that you provide to ensure the
77
+ # idempotency of the request.
78
+ # @return [String]
79
+ #
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareRequest AWS API Documentation
81
+ #
82
+ class AssociateResourceShareRequest < Struct.new(
83
+ :resource_share_arn,
84
+ :resource_arns,
85
+ :principals,
86
+ :client_token)
87
+ include Aws::Structure
88
+ end
89
+
90
+ # @!attribute [rw] resource_share_associations
91
+ # Information about the associations.
92
+ # @return [Array<Types::ResourceShareAssociation>]
93
+ #
94
+ # @!attribute [rw] client_token
95
+ # A unique, case-sensitive identifier that you provide to ensure the
96
+ # idempotency of the request.
97
+ # @return [String]
98
+ #
99
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareResponse AWS API Documentation
100
+ #
101
+ class AssociateResourceShareResponse < Struct.new(
102
+ :resource_share_associations,
103
+ :client_token)
104
+ include Aws::Structure
105
+ end
106
+
107
+ # @note When making an API call, you may pass CreateResourceShareRequest
108
+ # data as a hash:
109
+ #
110
+ # {
111
+ # name: "String", # required
112
+ # resource_arns: ["String"],
113
+ # principals: ["String"],
114
+ # tags: [
115
+ # {
116
+ # key: "TagKey",
117
+ # value: "TagValue",
118
+ # },
119
+ # ],
120
+ # allow_external_principals: false,
121
+ # client_token: "String",
122
+ # }
123
+ #
124
+ # @!attribute [rw] name
125
+ # The name of the resource share.
126
+ # @return [String]
127
+ #
128
+ # @!attribute [rw] resource_arns
129
+ # The Amazon Resource Names (ARN) of the resources to associate with
130
+ # the resource share.
131
+ # @return [Array<String>]
132
+ #
133
+ # @!attribute [rw] principals
134
+ # The principals to associate with the resource share. The possible
135
+ # values are IDs of AWS accounts, the ARN of an OU or organization
136
+ # from AWS Organizations.
137
+ # @return [Array<String>]
138
+ #
139
+ # @!attribute [rw] tags
140
+ # One or more tags.
141
+ # @return [Array<Types::Tag>]
142
+ #
143
+ # @!attribute [rw] allow_external_principals
144
+ # Indicates whether principals outside your organization can be
145
+ # associated with a resource share.
146
+ # @return [Boolean]
147
+ #
148
+ # @!attribute [rw] client_token
149
+ # A unique, case-sensitive identifier that you provide to ensure the
150
+ # idempotency of the request.
151
+ # @return [String]
152
+ #
153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareRequest AWS API Documentation
154
+ #
155
+ class CreateResourceShareRequest < Struct.new(
156
+ :name,
157
+ :resource_arns,
158
+ :principals,
159
+ :tags,
160
+ :allow_external_principals,
161
+ :client_token)
162
+ include Aws::Structure
163
+ end
164
+
165
+ # @!attribute [rw] resource_share
166
+ # Information about the resource share.
167
+ # @return [Types::ResourceShare]
168
+ #
169
+ # @!attribute [rw] client_token
170
+ # A unique, case-sensitive identifier that you provide to ensure the
171
+ # idempotency of the request.
172
+ # @return [String]
173
+ #
174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareResponse AWS API Documentation
175
+ #
176
+ class CreateResourceShareResponse < Struct.new(
177
+ :resource_share,
178
+ :client_token)
179
+ include Aws::Structure
180
+ end
181
+
182
+ # @note When making an API call, you may pass DeleteResourceShareRequest
183
+ # data as a hash:
184
+ #
185
+ # {
186
+ # resource_share_arn: "String", # required
187
+ # client_token: "String",
188
+ # }
189
+ #
190
+ # @!attribute [rw] resource_share_arn
191
+ # The Amazon Resource Name (ARN) of the resource share.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] client_token
195
+ # A unique, case-sensitive identifier that you provide to ensure the
196
+ # idempotency of the request.
197
+ # @return [String]
198
+ #
199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareRequest AWS API Documentation
200
+ #
201
+ class DeleteResourceShareRequest < Struct.new(
202
+ :resource_share_arn,
203
+ :client_token)
204
+ include Aws::Structure
205
+ end
206
+
207
+ # @!attribute [rw] return_value
208
+ # Indicates whether the request succeeded.
209
+ # @return [Boolean]
210
+ #
211
+ # @!attribute [rw] client_token
212
+ # A unique, case-sensitive identifier that you provide to ensure the
213
+ # idempotency of the request.
214
+ # @return [String]
215
+ #
216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareResponse AWS API Documentation
217
+ #
218
+ class DeleteResourceShareResponse < Struct.new(
219
+ :return_value,
220
+ :client_token)
221
+ include Aws::Structure
222
+ end
223
+
224
+ # @note When making an API call, you may pass DisassociateResourceShareRequest
225
+ # data as a hash:
226
+ #
227
+ # {
228
+ # resource_share_arn: "String", # required
229
+ # resource_arns: ["String"],
230
+ # principals: ["String"],
231
+ # client_token: "String",
232
+ # }
233
+ #
234
+ # @!attribute [rw] resource_share_arn
235
+ # The Amazon Resource Name (ARN) of the resource share.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] resource_arns
239
+ # The Amazon Resource Names (ARN) of the resources.
240
+ # @return [Array<String>]
241
+ #
242
+ # @!attribute [rw] principals
243
+ # The principals.
244
+ # @return [Array<String>]
245
+ #
246
+ # @!attribute [rw] client_token
247
+ # A unique, case-sensitive identifier that you provide to ensure the
248
+ # idempotency of the request.
249
+ # @return [String]
250
+ #
251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareRequest AWS API Documentation
252
+ #
253
+ class DisassociateResourceShareRequest < Struct.new(
254
+ :resource_share_arn,
255
+ :resource_arns,
256
+ :principals,
257
+ :client_token)
258
+ include Aws::Structure
259
+ end
260
+
261
+ # @!attribute [rw] resource_share_associations
262
+ # Information about the associations.
263
+ # @return [Array<Types::ResourceShareAssociation>]
264
+ #
265
+ # @!attribute [rw] client_token
266
+ # A unique, case-sensitive identifier that you provide to ensure the
267
+ # idempotency of the request.
268
+ # @return [String]
269
+ #
270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareResponse AWS API Documentation
271
+ #
272
+ class DisassociateResourceShareResponse < Struct.new(
273
+ :resource_share_associations,
274
+ :client_token)
275
+ include Aws::Structure
276
+ end
277
+
278
+ # @api private
279
+ #
280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/EnableSharingWithAwsOrganizationRequest AWS API Documentation
281
+ #
282
+ class EnableSharingWithAwsOrganizationRequest < Aws::EmptyStructure; end
283
+
284
+ # @!attribute [rw] return_value
285
+ # Indicates whether the request succeeded.
286
+ # @return [Boolean]
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/EnableSharingWithAwsOrganizationResponse AWS API Documentation
289
+ #
290
+ class EnableSharingWithAwsOrganizationResponse < Struct.new(
291
+ :return_value)
292
+ include Aws::Structure
293
+ end
294
+
295
+ # @note When making an API call, you may pass GetResourcePoliciesRequest
296
+ # data as a hash:
297
+ #
298
+ # {
299
+ # resource_arns: ["String"], # required
300
+ # principal: "String",
301
+ # next_token: "String",
302
+ # max_results: 1,
303
+ # }
304
+ #
305
+ # @!attribute [rw] resource_arns
306
+ # The Amazon Resource Names (ARN) of the resources.
307
+ # @return [Array<String>]
308
+ #
309
+ # @!attribute [rw] principal
310
+ # The principal.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] next_token
314
+ # The token for the next page of results.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] max_results
318
+ # The maximum number of results to return with a single call. To
319
+ # retrieve the remaining results, make another call with the returned
320
+ # `nextToken` value.
321
+ # @return [Integer]
322
+ #
323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesRequest AWS API Documentation
324
+ #
325
+ class GetResourcePoliciesRequest < Struct.new(
326
+ :resource_arns,
327
+ :principal,
328
+ :next_token,
329
+ :max_results)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] policies
334
+ # A key policy document, in JSON format.
335
+ # @return [Array<String>]
336
+ #
337
+ # @!attribute [rw] next_token
338
+ # The token to use to retrieve the next page of results. This value is
339
+ # `null` when there are no more results to return.
340
+ # @return [String]
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesResponse AWS API Documentation
343
+ #
344
+ class GetResourcePoliciesResponse < Struct.new(
345
+ :policies,
346
+ :next_token)
347
+ include Aws::Structure
348
+ end
349
+
350
+ # @note When making an API call, you may pass GetResourceShareAssociationsRequest
351
+ # data as a hash:
352
+ #
353
+ # {
354
+ # association_type: "PRINCIPAL", # required, accepts PRINCIPAL, RESOURCE
355
+ # resource_share_arns: ["String"],
356
+ # resource_arn: "String",
357
+ # principal: "String",
358
+ # association_status: "ASSOCIATING", # accepts ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED
359
+ # next_token: "String",
360
+ # max_results: 1,
361
+ # }
362
+ #
363
+ # @!attribute [rw] association_type
364
+ # The association type.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] resource_share_arns
368
+ # The Amazon Resource Names (ARN) of the resource shares.
369
+ # @return [Array<String>]
370
+ #
371
+ # @!attribute [rw] resource_arn
372
+ # The Amazon Resource Name (ARN) of the resource.
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] principal
376
+ # The principal.
377
+ # @return [String]
378
+ #
379
+ # @!attribute [rw] association_status
380
+ # The status of the association.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] next_token
384
+ # The token for the next page of results.
385
+ # @return [String]
386
+ #
387
+ # @!attribute [rw] max_results
388
+ # The maximum number of results to return with a single call. To
389
+ # retrieve the remaining results, make another call with the returned
390
+ # `nextToken` value.
391
+ # @return [Integer]
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsRequest AWS API Documentation
394
+ #
395
+ class GetResourceShareAssociationsRequest < Struct.new(
396
+ :association_type,
397
+ :resource_share_arns,
398
+ :resource_arn,
399
+ :principal,
400
+ :association_status,
401
+ :next_token,
402
+ :max_results)
403
+ include Aws::Structure
404
+ end
405
+
406
+ # @!attribute [rw] resource_share_associations
407
+ # Information about the association.
408
+ # @return [Array<Types::ResourceShareAssociation>]
409
+ #
410
+ # @!attribute [rw] next_token
411
+ # The token to use to retrieve the next page of results. This value is
412
+ # `null` when there are no more results to return.
413
+ # @return [String]
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsResponse AWS API Documentation
416
+ #
417
+ class GetResourceShareAssociationsResponse < Struct.new(
418
+ :resource_share_associations,
419
+ :next_token)
420
+ include Aws::Structure
421
+ end
422
+
423
+ # @note When making an API call, you may pass GetResourceShareInvitationsRequest
424
+ # data as a hash:
425
+ #
426
+ # {
427
+ # resource_share_invitation_arns: ["String"],
428
+ # resource_share_arns: ["String"],
429
+ # next_token: "String",
430
+ # max_results: 1,
431
+ # }
432
+ #
433
+ # @!attribute [rw] resource_share_invitation_arns
434
+ # The Amazon Resource Names (ARN) of the invitations.
435
+ # @return [Array<String>]
436
+ #
437
+ # @!attribute [rw] resource_share_arns
438
+ # The Amazon Resource Names (ARN) of the resource shares.
439
+ # @return [Array<String>]
440
+ #
441
+ # @!attribute [rw] next_token
442
+ # The token for the next page of results.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] max_results
446
+ # The maximum number of results to return with a single call. To
447
+ # retrieve the remaining results, make another call with the returned
448
+ # `nextToken` value.
449
+ # @return [Integer]
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsRequest AWS API Documentation
452
+ #
453
+ class GetResourceShareInvitationsRequest < Struct.new(
454
+ :resource_share_invitation_arns,
455
+ :resource_share_arns,
456
+ :next_token,
457
+ :max_results)
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @!attribute [rw] resource_share_invitations
462
+ # Information about the invitations.
463
+ # @return [Array<Types::ResourceShareInvitation>]
464
+ #
465
+ # @!attribute [rw] next_token
466
+ # The token to use to retrieve the next page of results. This value is
467
+ # `null` when there are no more results to return.
468
+ # @return [String]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsResponse AWS API Documentation
471
+ #
472
+ class GetResourceShareInvitationsResponse < Struct.new(
473
+ :resource_share_invitations,
474
+ :next_token)
475
+ include Aws::Structure
476
+ end
477
+
478
+ # @note When making an API call, you may pass GetResourceSharesRequest
479
+ # data as a hash:
480
+ #
481
+ # {
482
+ # resource_share_arns: ["String"],
483
+ # resource_share_status: "PENDING", # accepts PENDING, ACTIVE, FAILED, DELETING, DELETED
484
+ # resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
485
+ # name: "String",
486
+ # tag_filters: [
487
+ # {
488
+ # tag_key: "TagKey",
489
+ # tag_values: ["TagValue"],
490
+ # },
491
+ # ],
492
+ # next_token: "String",
493
+ # max_results: 1,
494
+ # }
495
+ #
496
+ # @!attribute [rw] resource_share_arns
497
+ # The Amazon Resource Names (ARN) of the resource shares.
498
+ # @return [Array<String>]
499
+ #
500
+ # @!attribute [rw] resource_share_status
501
+ # The status of the resource share.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] resource_owner
505
+ # The type of owner.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] name
509
+ # The name of the resource share.
510
+ # @return [String]
511
+ #
512
+ # @!attribute [rw] tag_filters
513
+ # One or more tag filters.
514
+ # @return [Array<Types::TagFilter>]
515
+ #
516
+ # @!attribute [rw] next_token
517
+ # The token for the next page of results.
518
+ # @return [String]
519
+ #
520
+ # @!attribute [rw] max_results
521
+ # The maximum number of results to return with a single call. To
522
+ # retrieve the remaining results, make another call with the returned
523
+ # `nextToken` value.
524
+ # @return [Integer]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesRequest AWS API Documentation
527
+ #
528
+ class GetResourceSharesRequest < Struct.new(
529
+ :resource_share_arns,
530
+ :resource_share_status,
531
+ :resource_owner,
532
+ :name,
533
+ :tag_filters,
534
+ :next_token,
535
+ :max_results)
536
+ include Aws::Structure
537
+ end
538
+
539
+ # @!attribute [rw] resource_shares
540
+ # Information about the resource shares.
541
+ # @return [Array<Types::ResourceShare>]
542
+ #
543
+ # @!attribute [rw] next_token
544
+ # The token to use to retrieve the next page of results. This value is
545
+ # `null` when there are no more results to return.
546
+ # @return [String]
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesResponse AWS API Documentation
549
+ #
550
+ class GetResourceSharesResponse < Struct.new(
551
+ :resource_shares,
552
+ :next_token)
553
+ include Aws::Structure
554
+ end
555
+
556
+ # @note When making an API call, you may pass ListPrincipalsRequest
557
+ # data as a hash:
558
+ #
559
+ # {
560
+ # resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
561
+ # resource_arn: "String",
562
+ # principals: ["String"],
563
+ # resource_type: "String",
564
+ # resource_share_arns: ["String"],
565
+ # next_token: "String",
566
+ # max_results: 1,
567
+ # }
568
+ #
569
+ # @!attribute [rw] resource_owner
570
+ # The type of owner.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] resource_arn
574
+ # The Amazon Resource Name (ARN) of the resource.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] principals
578
+ # The principals.
579
+ # @return [Array<String>]
580
+ #
581
+ # @!attribute [rw] resource_type
582
+ # The resource type.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] resource_share_arns
586
+ # The Amazon Resource Names (ARN) of the resource shares.
587
+ # @return [Array<String>]
588
+ #
589
+ # @!attribute [rw] next_token
590
+ # The token for the next page of results.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] max_results
594
+ # The maximum number of results to return with a single call. To
595
+ # retrieve the remaining results, make another call with the returned
596
+ # `nextToken` value.
597
+ # @return [Integer]
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsRequest AWS API Documentation
600
+ #
601
+ class ListPrincipalsRequest < Struct.new(
602
+ :resource_owner,
603
+ :resource_arn,
604
+ :principals,
605
+ :resource_type,
606
+ :resource_share_arns,
607
+ :next_token,
608
+ :max_results)
609
+ include Aws::Structure
610
+ end
611
+
612
+ # @!attribute [rw] principals
613
+ # The principals.
614
+ # @return [Array<Types::Principal>]
615
+ #
616
+ # @!attribute [rw] next_token
617
+ # The token to use to retrieve the next page of results. This value is
618
+ # `null` when there are no more results to return.
619
+ # @return [String]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsResponse AWS API Documentation
622
+ #
623
+ class ListPrincipalsResponse < Struct.new(
624
+ :principals,
625
+ :next_token)
626
+ include Aws::Structure
627
+ end
628
+
629
+ # @note When making an API call, you may pass ListResourcesRequest
630
+ # data as a hash:
631
+ #
632
+ # {
633
+ # resource_owner: "SELF", # required, accepts SELF, OTHER-ACCOUNTS
634
+ # principal: "String",
635
+ # resource_type: "String",
636
+ # resource_arns: ["String"],
637
+ # resource_share_arns: ["String"],
638
+ # next_token: "String",
639
+ # max_results: 1,
640
+ # }
641
+ #
642
+ # @!attribute [rw] resource_owner
643
+ # The type of owner.
644
+ # @return [String]
645
+ #
646
+ # @!attribute [rw] principal
647
+ # The principal.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] resource_type
651
+ # The resource type.
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] resource_arns
655
+ # The Amazon Resource Names (ARN) of the resources.
656
+ # @return [Array<String>]
657
+ #
658
+ # @!attribute [rw] resource_share_arns
659
+ # The Amazon Resource Names (ARN) of the resource shares.
660
+ # @return [Array<String>]
661
+ #
662
+ # @!attribute [rw] next_token
663
+ # The token for the next page of results.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] max_results
667
+ # The maximum number of results to return with a single call. To
668
+ # retrieve the remaining results, make another call with the returned
669
+ # `nextToken` value.
670
+ # @return [Integer]
671
+ #
672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesRequest AWS API Documentation
673
+ #
674
+ class ListResourcesRequest < Struct.new(
675
+ :resource_owner,
676
+ :principal,
677
+ :resource_type,
678
+ :resource_arns,
679
+ :resource_share_arns,
680
+ :next_token,
681
+ :max_results)
682
+ include Aws::Structure
683
+ end
684
+
685
+ # @!attribute [rw] resources
686
+ # Information about the resources.
687
+ # @return [Array<Types::Resource>]
688
+ #
689
+ # @!attribute [rw] next_token
690
+ # The token to use to retrieve the next page of results. This value is
691
+ # `null` when there are no more results to return.
692
+ # @return [String]
693
+ #
694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesResponse AWS API Documentation
695
+ #
696
+ class ListResourcesResponse < Struct.new(
697
+ :resources,
698
+ :next_token)
699
+ include Aws::Structure
700
+ end
701
+
702
+ # Describes a principal for use with AWS Resource Access Manager.
703
+ #
704
+ # @!attribute [rw] id
705
+ # The ID of the principal.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] resource_share_arn
709
+ # The Amazon Resource Name (ARN) of the resource share.
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] creation_time
713
+ # The time when the principal was associated with the resource share.
714
+ # @return [Time]
715
+ #
716
+ # @!attribute [rw] last_updated_time
717
+ # The time when the association was last updated.
718
+ # @return [Time]
719
+ #
720
+ # @!attribute [rw] external
721
+ # Indicates whether the principal belongs to the same organization as
722
+ # the AWS account that owns the resource share.
723
+ # @return [Boolean]
724
+ #
725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Principal AWS API Documentation
726
+ #
727
+ class Principal < Struct.new(
728
+ :id,
729
+ :resource_share_arn,
730
+ :creation_time,
731
+ :last_updated_time,
732
+ :external)
733
+ include Aws::Structure
734
+ end
735
+
736
+ # @note When making an API call, you may pass RejectResourceShareInvitationRequest
737
+ # data as a hash:
738
+ #
739
+ # {
740
+ # resource_share_invitation_arn: "String", # required
741
+ # client_token: "String",
742
+ # }
743
+ #
744
+ # @!attribute [rw] resource_share_invitation_arn
745
+ # The Amazon Resource Name (ARN) of the invitation.
746
+ # @return [String]
747
+ #
748
+ # @!attribute [rw] client_token
749
+ # A unique, case-sensitive identifier that you provide to ensure the
750
+ # idempotency of the request.
751
+ # @return [String]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationRequest AWS API Documentation
754
+ #
755
+ class RejectResourceShareInvitationRequest < Struct.new(
756
+ :resource_share_invitation_arn,
757
+ :client_token)
758
+ include Aws::Structure
759
+ end
760
+
761
+ # @!attribute [rw] resource_share_invitation
762
+ # Information about the invitation.
763
+ # @return [Types::ResourceShareInvitation]
764
+ #
765
+ # @!attribute [rw] client_token
766
+ # A unique, case-sensitive identifier that you provide to ensure the
767
+ # idempotency of the request.
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationResponse AWS API Documentation
771
+ #
772
+ class RejectResourceShareInvitationResponse < Struct.new(
773
+ :resource_share_invitation,
774
+ :client_token)
775
+ include Aws::Structure
776
+ end
777
+
778
+ # Describes a resource associated with a resource share.
779
+ #
780
+ # @!attribute [rw] arn
781
+ # The Amazon Resource Name (ARN) of the resource.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] type
785
+ # The resource type.
786
+ # @return [String]
787
+ #
788
+ # @!attribute [rw] resource_share_arn
789
+ # The Amazon Resource Name (ARN) of the resource share.
790
+ # @return [String]
791
+ #
792
+ # @!attribute [rw] status
793
+ # The status of the resource.
794
+ # @return [String]
795
+ #
796
+ # @!attribute [rw] status_message
797
+ # A message about the status of the resource.
798
+ # @return [String]
799
+ #
800
+ # @!attribute [rw] creation_time
801
+ # The time when the resource was associated with the resource share.
802
+ # @return [Time]
803
+ #
804
+ # @!attribute [rw] last_updated_time
805
+ # The time when the association was last updated.
806
+ # @return [Time]
807
+ #
808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Resource AWS API Documentation
809
+ #
810
+ class Resource < Struct.new(
811
+ :arn,
812
+ :type,
813
+ :resource_share_arn,
814
+ :status,
815
+ :status_message,
816
+ :creation_time,
817
+ :last_updated_time)
818
+ include Aws::Structure
819
+ end
820
+
821
+ # Describes a resource share.
822
+ #
823
+ # @!attribute [rw] resource_share_arn
824
+ # The Amazon Resource Name (ARN) of the resource share.
825
+ # @return [String]
826
+ #
827
+ # @!attribute [rw] name
828
+ # The name of the resource share.
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] owning_account_id
832
+ # The ID of the AWS account that owns the resource share.
833
+ # @return [String]
834
+ #
835
+ # @!attribute [rw] allow_external_principals
836
+ # Indicates whether principals outside your organization can be
837
+ # associated with a resource share.
838
+ # @return [Boolean]
839
+ #
840
+ # @!attribute [rw] status
841
+ # The status of the resource share.
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] status_message
845
+ # A message about the status of the resource share.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] tags
849
+ # The tags for the resource share.
850
+ # @return [Array<Types::Tag>]
851
+ #
852
+ # @!attribute [rw] creation_time
853
+ # The time when the resource share was created.
854
+ # @return [Time]
855
+ #
856
+ # @!attribute [rw] last_updated_time
857
+ # The time when the resource share was last updated.
858
+ # @return [Time]
859
+ #
860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShare AWS API Documentation
861
+ #
862
+ class ResourceShare < Struct.new(
863
+ :resource_share_arn,
864
+ :name,
865
+ :owning_account_id,
866
+ :allow_external_principals,
867
+ :status,
868
+ :status_message,
869
+ :tags,
870
+ :creation_time,
871
+ :last_updated_time)
872
+ include Aws::Structure
873
+ end
874
+
875
+ # Describes an association with a resource share.
876
+ #
877
+ # @!attribute [rw] resource_share_arn
878
+ # The Amazon Resource Name (ARN) of the resource share.
879
+ # @return [String]
880
+ #
881
+ # @!attribute [rw] associated_entity
882
+ # The associated entity. For resource associations, this is the ARN of
883
+ # the resource. For principal associations, this is the ID of an AWS
884
+ # account or the ARN of an OU or organization from AWS Organizations.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] association_type
888
+ # The association type.
889
+ # @return [String]
890
+ #
891
+ # @!attribute [rw] status
892
+ # The status of the association.
893
+ # @return [String]
894
+ #
895
+ # @!attribute [rw] status_message
896
+ # A message about the status of the association.
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] creation_time
900
+ # The time when the association was created.
901
+ # @return [Time]
902
+ #
903
+ # @!attribute [rw] last_updated_time
904
+ # The time when the association was last updated.
905
+ # @return [Time]
906
+ #
907
+ # @!attribute [rw] external
908
+ # Indicates whether the principal belongs to the same organization as
909
+ # the AWS account that owns the resource share.
910
+ # @return [Boolean]
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShareAssociation AWS API Documentation
913
+ #
914
+ class ResourceShareAssociation < Struct.new(
915
+ :resource_share_arn,
916
+ :associated_entity,
917
+ :association_type,
918
+ :status,
919
+ :status_message,
920
+ :creation_time,
921
+ :last_updated_time,
922
+ :external)
923
+ include Aws::Structure
924
+ end
925
+
926
+ # Describes an invitation to join a resource share.
927
+ #
928
+ # @!attribute [rw] resource_share_invitation_arn
929
+ # The Amazon Resource Name (ARN) of the invitation.
930
+ # @return [String]
931
+ #
932
+ # @!attribute [rw] resource_share_name
933
+ # The name of the resource share.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] resource_share_arn
937
+ # The Amazon Resource Name (ARN) of the resource share.
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] sender_account_id
941
+ # The ID of the AWS account that sent the invitation.
942
+ # @return [String]
943
+ #
944
+ # @!attribute [rw] receiver_account_id
945
+ # The ID of the AWS account that received the invitation.
946
+ # @return [String]
947
+ #
948
+ # @!attribute [rw] invitation_timestamp
949
+ # The date and time when the invitation was sent.
950
+ # @return [Time]
951
+ #
952
+ # @!attribute [rw] status
953
+ # The status of the invitation.
954
+ # @return [String]
955
+ #
956
+ # @!attribute [rw] resource_share_associations
957
+ # The resources associated with the resource share.
958
+ # @return [Array<Types::ResourceShareAssociation>]
959
+ #
960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShareInvitation AWS API Documentation
961
+ #
962
+ class ResourceShareInvitation < Struct.new(
963
+ :resource_share_invitation_arn,
964
+ :resource_share_name,
965
+ :resource_share_arn,
966
+ :sender_account_id,
967
+ :receiver_account_id,
968
+ :invitation_timestamp,
969
+ :status,
970
+ :resource_share_associations)
971
+ include Aws::Structure
972
+ end
973
+
974
+ # Information about a tag.
975
+ #
976
+ # @note When making an API call, you may pass Tag
977
+ # data as a hash:
978
+ #
979
+ # {
980
+ # key: "TagKey",
981
+ # value: "TagValue",
982
+ # }
983
+ #
984
+ # @!attribute [rw] key
985
+ # The key of the tag.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] value
989
+ # The value of the tag.
990
+ # @return [String]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Tag AWS API Documentation
993
+ #
994
+ class Tag < Struct.new(
995
+ :key,
996
+ :value)
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # Used to filter information based on tags.
1001
+ #
1002
+ # @note When making an API call, you may pass TagFilter
1003
+ # data as a hash:
1004
+ #
1005
+ # {
1006
+ # tag_key: "TagKey",
1007
+ # tag_values: ["TagValue"],
1008
+ # }
1009
+ #
1010
+ # @!attribute [rw] tag_key
1011
+ # The tag key.
1012
+ # @return [String]
1013
+ #
1014
+ # @!attribute [rw] tag_values
1015
+ # The tag values.
1016
+ # @return [Array<String>]
1017
+ #
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagFilter AWS API Documentation
1019
+ #
1020
+ class TagFilter < Struct.new(
1021
+ :tag_key,
1022
+ :tag_values)
1023
+ include Aws::Structure
1024
+ end
1025
+
1026
+ # @note When making an API call, you may pass TagResourceRequest
1027
+ # data as a hash:
1028
+ #
1029
+ # {
1030
+ # resource_share_arn: "String", # required
1031
+ # tags: [ # required
1032
+ # {
1033
+ # key: "TagKey",
1034
+ # value: "TagValue",
1035
+ # },
1036
+ # ],
1037
+ # }
1038
+ #
1039
+ # @!attribute [rw] resource_share_arn
1040
+ # The Amazon Resource Name (ARN) of the resource share.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] tags
1044
+ # One or more tags.
1045
+ # @return [Array<Types::Tag>]
1046
+ #
1047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagResourceRequest AWS API Documentation
1048
+ #
1049
+ class TagResourceRequest < Struct.new(
1050
+ :resource_share_arn,
1051
+ :tags)
1052
+ include Aws::Structure
1053
+ end
1054
+
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagResourceResponse AWS API Documentation
1056
+ #
1057
+ class TagResourceResponse < Aws::EmptyStructure; end
1058
+
1059
+ # @note When making an API call, you may pass UntagResourceRequest
1060
+ # data as a hash:
1061
+ #
1062
+ # {
1063
+ # resource_share_arn: "String", # required
1064
+ # tag_keys: ["TagKey"], # required
1065
+ # }
1066
+ #
1067
+ # @!attribute [rw] resource_share_arn
1068
+ # The Amazon Resource Name (ARN) of the resource share.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] tag_keys
1072
+ # The tag keys of the tags to remove.
1073
+ # @return [Array<String>]
1074
+ #
1075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UntagResourceRequest AWS API Documentation
1076
+ #
1077
+ class UntagResourceRequest < Struct.new(
1078
+ :resource_share_arn,
1079
+ :tag_keys)
1080
+ include Aws::Structure
1081
+ end
1082
+
1083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UntagResourceResponse AWS API Documentation
1084
+ #
1085
+ class UntagResourceResponse < Aws::EmptyStructure; end
1086
+
1087
+ # @note When making an API call, you may pass UpdateResourceShareRequest
1088
+ # data as a hash:
1089
+ #
1090
+ # {
1091
+ # resource_share_arn: "String", # required
1092
+ # name: "String",
1093
+ # allow_external_principals: false,
1094
+ # client_token: "String",
1095
+ # }
1096
+ #
1097
+ # @!attribute [rw] resource_share_arn
1098
+ # The Amazon Resource Name (ARN) of the resource share.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] name
1102
+ # The name of the resource share.
1103
+ # @return [String]
1104
+ #
1105
+ # @!attribute [rw] allow_external_principals
1106
+ # Indicates whether principals outside your organization can be
1107
+ # associated with a resource share.
1108
+ # @return [Boolean]
1109
+ #
1110
+ # @!attribute [rw] client_token
1111
+ # A unique, case-sensitive identifier that you provide to ensure the
1112
+ # idempotency of the request.
1113
+ # @return [String]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareRequest AWS API Documentation
1116
+ #
1117
+ class UpdateResourceShareRequest < Struct.new(
1118
+ :resource_share_arn,
1119
+ :name,
1120
+ :allow_external_principals,
1121
+ :client_token)
1122
+ include Aws::Structure
1123
+ end
1124
+
1125
+ # @!attribute [rw] resource_share
1126
+ # Information about the resource share.
1127
+ # @return [Types::ResourceShare]
1128
+ #
1129
+ # @!attribute [rw] client_token
1130
+ # A unique, case-sensitive identifier that you provide to ensure the
1131
+ # idempotency of the request.
1132
+ # @return [String]
1133
+ #
1134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareResponse AWS API Documentation
1135
+ #
1136
+ class UpdateResourceShareResponse < Struct.new(
1137
+ :resource_share,
1138
+ :client_token)
1139
+ include Aws::Structure
1140
+ end
1141
+
1142
+ end
1143
+ end