aws-sdk-clouddirectory 1.0.0.rc1

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,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::CloudDirectory
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::CloudDirectory
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,3927 @@
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::CloudDirectory
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AddFacetToObjectRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # directory_arn: "Arn", # required
16
+ # schema_facet: { # required
17
+ # schema_arn: "Arn",
18
+ # facet_name: "FacetName",
19
+ # },
20
+ # object_attribute_list: [
21
+ # {
22
+ # key: { # required
23
+ # schema_arn: "Arn", # required
24
+ # facet_name: "FacetName", # required
25
+ # name: "AttributeName", # required
26
+ # },
27
+ # value: { # required
28
+ # string_value: "StringAttributeValue",
29
+ # binary_value: "data",
30
+ # boolean_value: false,
31
+ # number_value: "NumberAttributeValue",
32
+ # datetime_value: Time.now,
33
+ # },
34
+ # },
35
+ # ],
36
+ # object_reference: { # required
37
+ # selector: "SelectorObjectReference",
38
+ # },
39
+ # }
40
+ #
41
+ # @!attribute [rw] directory_arn
42
+ # ARN associated with the Directory where the object resides. For more
43
+ # information, see arns.
44
+ # @return [String]
45
+ #
46
+ # @!attribute [rw] schema_facet
47
+ # Identifiers for the facet that you are adding to the object.
48
+ # @return [Types::SchemaFacet]
49
+ #
50
+ # @!attribute [rw] object_attribute_list
51
+ # Attributes on the facet you are adding to the object.
52
+ # @return [Array<Types::AttributeKeyAndValue>]
53
+ #
54
+ # @!attribute [rw] object_reference
55
+ # A reference to the object you are adding the specified facet to.
56
+ # @return [Types::ObjectReference]
57
+ #
58
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AddFacetToObjectRequest AWS API Documentation
59
+ #
60
+ class AddFacetToObjectRequest < Struct.new(
61
+ :directory_arn,
62
+ :schema_facet,
63
+ :object_attribute_list,
64
+ :object_reference)
65
+ include Aws::Structure
66
+ end
67
+
68
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AddFacetToObjectResponse AWS API Documentation
69
+ #
70
+ class AddFacetToObjectResponse < Aws::EmptyStructure; end
71
+
72
+ # @note When making an API call, you may pass ApplySchemaRequest
73
+ # data as a hash:
74
+ #
75
+ # {
76
+ # published_schema_arn: "Arn", # required
77
+ # directory_arn: "Arn", # required
78
+ # }
79
+ #
80
+ # @!attribute [rw] published_schema_arn
81
+ # Published schema ARN that needs to be copied. For more information,
82
+ # see arns.
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] directory_arn
86
+ # ARN associated with the Directory into which the schema is copied.
87
+ # For more information, see arns.
88
+ # @return [String]
89
+ #
90
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaRequest AWS API Documentation
91
+ #
92
+ class ApplySchemaRequest < Struct.new(
93
+ :published_schema_arn,
94
+ :directory_arn)
95
+ include Aws::Structure
96
+ end
97
+
98
+ # @!attribute [rw] applied_schema_arn
99
+ # Applied schema ARN associated with the copied schema in the
100
+ # Directory. You can use this ARN to describe the schema information
101
+ # applied on this directory. For more information, see arns.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] directory_arn
105
+ # ARN associated with the Directory. For more information, see arns.
106
+ # @return [String]
107
+ #
108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaResponse AWS API Documentation
109
+ #
110
+ class ApplySchemaResponse < Struct.new(
111
+ :applied_schema_arn,
112
+ :directory_arn)
113
+ include Aws::Structure
114
+ end
115
+
116
+ # @note When making an API call, you may pass AttachObjectRequest
117
+ # data as a hash:
118
+ #
119
+ # {
120
+ # directory_arn: "Arn", # required
121
+ # parent_reference: { # required
122
+ # selector: "SelectorObjectReference",
123
+ # },
124
+ # child_reference: { # required
125
+ # selector: "SelectorObjectReference",
126
+ # },
127
+ # link_name: "LinkName", # required
128
+ # }
129
+ #
130
+ # @!attribute [rw] directory_arn
131
+ # ARN associated with the Directory where both objects reside. For
132
+ # more information, see arns.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] parent_reference
136
+ # Parent object reference.
137
+ # @return [Types::ObjectReference]
138
+ #
139
+ # @!attribute [rw] child_reference
140
+ # Child object reference to be attached to the object.
141
+ # @return [Types::ObjectReference]
142
+ #
143
+ # @!attribute [rw] link_name
144
+ # Link name with which the child object is attached to the parent.
145
+ # @return [String]
146
+ #
147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectRequest AWS API Documentation
148
+ #
149
+ class AttachObjectRequest < Struct.new(
150
+ :directory_arn,
151
+ :parent_reference,
152
+ :child_reference,
153
+ :link_name)
154
+ include Aws::Structure
155
+ end
156
+
157
+ # @!attribute [rw] attached_object_identifier
158
+ # Attached ObjectIdentifier, which is the child ObjectIdentifier.
159
+ # @return [String]
160
+ #
161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectResponse AWS API Documentation
162
+ #
163
+ class AttachObjectResponse < Struct.new(
164
+ :attached_object_identifier)
165
+ include Aws::Structure
166
+ end
167
+
168
+ # @note When making an API call, you may pass AttachPolicyRequest
169
+ # data as a hash:
170
+ #
171
+ # {
172
+ # directory_arn: "Arn",
173
+ # policy_reference: { # required
174
+ # selector: "SelectorObjectReference",
175
+ # },
176
+ # object_reference: { # required
177
+ # selector: "SelectorObjectReference",
178
+ # },
179
+ # }
180
+ #
181
+ # @!attribute [rw] directory_arn
182
+ # ARN associated with the Directory where both objects reside. For
183
+ # more information, see arns.
184
+ # @return [String]
185
+ #
186
+ # @!attribute [rw] policy_reference
187
+ # Reference associated with the policy object.
188
+ # @return [Types::ObjectReference]
189
+ #
190
+ # @!attribute [rw] object_reference
191
+ # Reference that identifies the object to which the policy will be
192
+ # attached.
193
+ # @return [Types::ObjectReference]
194
+ #
195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachPolicyRequest AWS API Documentation
196
+ #
197
+ class AttachPolicyRequest < Struct.new(
198
+ :directory_arn,
199
+ :policy_reference,
200
+ :object_reference)
201
+ include Aws::Structure
202
+ end
203
+
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachPolicyResponse AWS API Documentation
205
+ #
206
+ class AttachPolicyResponse < Aws::EmptyStructure; end
207
+
208
+ # @note When making an API call, you may pass AttachToIndexRequest
209
+ # data as a hash:
210
+ #
211
+ # {
212
+ # directory_arn: "Arn", # required
213
+ # index_reference: { # required
214
+ # selector: "SelectorObjectReference",
215
+ # },
216
+ # target_reference: { # required
217
+ # selector: "SelectorObjectReference",
218
+ # },
219
+ # }
220
+ #
221
+ # @!attribute [rw] directory_arn
222
+ # The ARN of the directory where the object and index exist.
223
+ # @return [String]
224
+ #
225
+ # @!attribute [rw] index_reference
226
+ # A reference to the index that you are attaching the object to.
227
+ # @return [Types::ObjectReference]
228
+ #
229
+ # @!attribute [rw] target_reference
230
+ # A reference to the object that you are attaching to the index.
231
+ # @return [Types::ObjectReference]
232
+ #
233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachToIndexRequest AWS API Documentation
234
+ #
235
+ class AttachToIndexRequest < Struct.new(
236
+ :directory_arn,
237
+ :index_reference,
238
+ :target_reference)
239
+ include Aws::Structure
240
+ end
241
+
242
+ # @!attribute [rw] attached_object_identifier
243
+ # The ObjectIdentifier of the object that was attached to the index.
244
+ # @return [String]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachToIndexResponse AWS API Documentation
247
+ #
248
+ class AttachToIndexResponse < Struct.new(
249
+ :attached_object_identifier)
250
+ include Aws::Structure
251
+ end
252
+
253
+ # A unique identifier for an attribute.
254
+ #
255
+ # @note When making an API call, you may pass AttributeKey
256
+ # data as a hash:
257
+ #
258
+ # {
259
+ # schema_arn: "Arn", # required
260
+ # facet_name: "FacetName", # required
261
+ # name: "AttributeName", # required
262
+ # }
263
+ #
264
+ # @!attribute [rw] schema_arn
265
+ # The ARN of the schema that contains the facet and attribute.
266
+ # @return [String]
267
+ #
268
+ # @!attribute [rw] facet_name
269
+ # The name of the facet the attribute exists within.
270
+ # @return [String]
271
+ #
272
+ # @!attribute [rw] name
273
+ # The name of the attribute.
274
+ # @return [String]
275
+ #
276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttributeKey AWS API Documentation
277
+ #
278
+ class AttributeKey < Struct.new(
279
+ :schema_arn,
280
+ :facet_name,
281
+ :name)
282
+ include Aws::Structure
283
+ end
284
+
285
+ # The combination of an attribute key and an attribute value.
286
+ #
287
+ # @note When making an API call, you may pass AttributeKeyAndValue
288
+ # data as a hash:
289
+ #
290
+ # {
291
+ # key: { # required
292
+ # schema_arn: "Arn", # required
293
+ # facet_name: "FacetName", # required
294
+ # name: "AttributeName", # required
295
+ # },
296
+ # value: { # required
297
+ # string_value: "StringAttributeValue",
298
+ # binary_value: "data",
299
+ # boolean_value: false,
300
+ # number_value: "NumberAttributeValue",
301
+ # datetime_value: Time.now,
302
+ # },
303
+ # }
304
+ #
305
+ # @!attribute [rw] key
306
+ # The key of the attribute.
307
+ # @return [Types::AttributeKey]
308
+ #
309
+ # @!attribute [rw] value
310
+ # The value of the attribute.
311
+ # @return [Types::TypedAttributeValue]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttributeKeyAndValue AWS API Documentation
314
+ #
315
+ class AttributeKeyAndValue < Struct.new(
316
+ :key,
317
+ :value)
318
+ include Aws::Structure
319
+ end
320
+
321
+ # Represents the output of a batch add facet to object operation.
322
+ #
323
+ # @note When making an API call, you may pass BatchAddFacetToObject
324
+ # data as a hash:
325
+ #
326
+ # {
327
+ # schema_facet: { # required
328
+ # schema_arn: "Arn",
329
+ # facet_name: "FacetName",
330
+ # },
331
+ # object_attribute_list: [ # required
332
+ # {
333
+ # key: { # required
334
+ # schema_arn: "Arn", # required
335
+ # facet_name: "FacetName", # required
336
+ # name: "AttributeName", # required
337
+ # },
338
+ # value: { # required
339
+ # string_value: "StringAttributeValue",
340
+ # binary_value: "data",
341
+ # boolean_value: false,
342
+ # number_value: "NumberAttributeValue",
343
+ # datetime_value: Time.now,
344
+ # },
345
+ # },
346
+ # ],
347
+ # object_reference: { # required
348
+ # selector: "SelectorObjectReference",
349
+ # },
350
+ # }
351
+ #
352
+ # @!attribute [rw] schema_facet
353
+ # Represents the facet being added to the object.
354
+ # @return [Types::SchemaFacet]
355
+ #
356
+ # @!attribute [rw] object_attribute_list
357
+ # The attributes to set on the object.
358
+ # @return [Array<Types::AttributeKeyAndValue>]
359
+ #
360
+ # @!attribute [rw] object_reference
361
+ # A reference to the object being mutated.
362
+ # @return [Types::ObjectReference]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAddFacetToObject AWS API Documentation
365
+ #
366
+ class BatchAddFacetToObject < Struct.new(
367
+ :schema_facet,
368
+ :object_attribute_list,
369
+ :object_reference)
370
+ include Aws::Structure
371
+ end
372
+
373
+ # The result of a batch add facet to object operation.
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAddFacetToObjectResponse AWS API Documentation
376
+ #
377
+ class BatchAddFacetToObjectResponse < Aws::EmptyStructure; end
378
+
379
+ # Represents the output of an AttachObject operation.
380
+ #
381
+ # @note When making an API call, you may pass BatchAttachObject
382
+ # data as a hash:
383
+ #
384
+ # {
385
+ # parent_reference: { # required
386
+ # selector: "SelectorObjectReference",
387
+ # },
388
+ # child_reference: { # required
389
+ # selector: "SelectorObjectReference",
390
+ # },
391
+ # link_name: "LinkName", # required
392
+ # }
393
+ #
394
+ # @!attribute [rw] parent_reference
395
+ # Parent object reference.
396
+ # @return [Types::ObjectReference]
397
+ #
398
+ # @!attribute [rw] child_reference
399
+ # Child object reference to be attached to the object.
400
+ # @return [Types::ObjectReference]
401
+ #
402
+ # @!attribute [rw] link_name
403
+ # The name of the link.
404
+ # @return [String]
405
+ #
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAttachObject AWS API Documentation
407
+ #
408
+ class BatchAttachObject < Struct.new(
409
+ :parent_reference,
410
+ :child_reference,
411
+ :link_name)
412
+ include Aws::Structure
413
+ end
414
+
415
+ # Represents the output batch AttachObject response operation.
416
+ #
417
+ # @!attribute [rw] attached_object_identifier
418
+ # The ObjectIdentifier of the object that has been attached.
419
+ # @return [String]
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAttachObjectResponse AWS API Documentation
422
+ #
423
+ class BatchAttachObjectResponse < Struct.new(
424
+ :attached_object_identifier)
425
+ include Aws::Structure
426
+ end
427
+
428
+ # Represents the output of a CreateObject operation.
429
+ #
430
+ # @note When making an API call, you may pass BatchCreateObject
431
+ # data as a hash:
432
+ #
433
+ # {
434
+ # schema_facet: [ # required
435
+ # {
436
+ # schema_arn: "Arn",
437
+ # facet_name: "FacetName",
438
+ # },
439
+ # ],
440
+ # object_attribute_list: [ # required
441
+ # {
442
+ # key: { # required
443
+ # schema_arn: "Arn", # required
444
+ # facet_name: "FacetName", # required
445
+ # name: "AttributeName", # required
446
+ # },
447
+ # value: { # required
448
+ # string_value: "StringAttributeValue",
449
+ # binary_value: "data",
450
+ # boolean_value: false,
451
+ # number_value: "NumberAttributeValue",
452
+ # datetime_value: Time.now,
453
+ # },
454
+ # },
455
+ # ],
456
+ # parent_reference: { # required
457
+ # selector: "SelectorObjectReference",
458
+ # },
459
+ # link_name: "LinkName", # required
460
+ # batch_reference_name: "BatchReferenceName", # required
461
+ # }
462
+ #
463
+ # @!attribute [rw] schema_facet
464
+ # List of FacetArns that will be associated with the object. For more
465
+ # information, see arns.
466
+ # @return [Array<Types::SchemaFacet>]
467
+ #
468
+ # @!attribute [rw] object_attribute_list
469
+ # Attribute map, which contains an attribute ARN as the key and
470
+ # attribute value as the map value.
471
+ # @return [Array<Types::AttributeKeyAndValue>]
472
+ #
473
+ # @!attribute [rw] parent_reference
474
+ # If specified, the parent reference to which this object will be
475
+ # attached.
476
+ # @return [Types::ObjectReference]
477
+ #
478
+ # @!attribute [rw] link_name
479
+ # The name of the link.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] batch_reference_name
483
+ # The batch reference name. See [Batches][1] for more information.
484
+ #
485
+ #
486
+ #
487
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches
488
+ # @return [String]
489
+ #
490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchCreateObject AWS API Documentation
491
+ #
492
+ class BatchCreateObject < Struct.new(
493
+ :schema_facet,
494
+ :object_attribute_list,
495
+ :parent_reference,
496
+ :link_name,
497
+ :batch_reference_name)
498
+ include Aws::Structure
499
+ end
500
+
501
+ # Represents the output of a CreateObject response operation.
502
+ #
503
+ # @!attribute [rw] object_identifier
504
+ # ID associated with the object.
505
+ # @return [String]
506
+ #
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchCreateObjectResponse AWS API Documentation
508
+ #
509
+ class BatchCreateObjectResponse < Struct.new(
510
+ :object_identifier)
511
+ include Aws::Structure
512
+ end
513
+
514
+ # Represents the output of a DeleteObject operation.
515
+ #
516
+ # @note When making an API call, you may pass BatchDeleteObject
517
+ # data as a hash:
518
+ #
519
+ # {
520
+ # object_reference: { # required
521
+ # selector: "SelectorObjectReference",
522
+ # },
523
+ # }
524
+ #
525
+ # @!attribute [rw] object_reference
526
+ # Reference that identifies the object.
527
+ # @return [Types::ObjectReference]
528
+ #
529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDeleteObject AWS API Documentation
530
+ #
531
+ class BatchDeleteObject < Struct.new(
532
+ :object_reference)
533
+ include Aws::Structure
534
+ end
535
+
536
+ # Represents the output of a DeleteObject response operation.
537
+ #
538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDeleteObjectResponse AWS API Documentation
539
+ #
540
+ class BatchDeleteObjectResponse < Aws::EmptyStructure; end
541
+
542
+ # Represents the output of a DetachObject operation.
543
+ #
544
+ # @note When making an API call, you may pass BatchDetachObject
545
+ # data as a hash:
546
+ #
547
+ # {
548
+ # parent_reference: { # required
549
+ # selector: "SelectorObjectReference",
550
+ # },
551
+ # link_name: "LinkName", # required
552
+ # batch_reference_name: "BatchReferenceName", # required
553
+ # }
554
+ #
555
+ # @!attribute [rw] parent_reference
556
+ # Parent reference from which the object with the specified link name
557
+ # is detached.
558
+ # @return [Types::ObjectReference]
559
+ #
560
+ # @!attribute [rw] link_name
561
+ # The name of the link.
562
+ # @return [String]
563
+ #
564
+ # @!attribute [rw] batch_reference_name
565
+ # The batch reference name. See [Batches][1] for more information.
566
+ #
567
+ #
568
+ #
569
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches
570
+ # @return [String]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDetachObject AWS API Documentation
573
+ #
574
+ class BatchDetachObject < Struct.new(
575
+ :parent_reference,
576
+ :link_name,
577
+ :batch_reference_name)
578
+ include Aws::Structure
579
+ end
580
+
581
+ # Represents the output of a DetachObject response operation.
582
+ #
583
+ # @!attribute [rw] detached_object_identifier
584
+ # The ObjectIdentifier of the detached object.
585
+ # @return [String]
586
+ #
587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDetachObjectResponse AWS API Documentation
588
+ #
589
+ class BatchDetachObjectResponse < Struct.new(
590
+ :detached_object_identifier)
591
+ include Aws::Structure
592
+ end
593
+
594
+ # Represents the output of a ListObjectAttributes operation.
595
+ #
596
+ # @note When making an API call, you may pass BatchListObjectAttributes
597
+ # data as a hash:
598
+ #
599
+ # {
600
+ # object_reference: { # required
601
+ # selector: "SelectorObjectReference",
602
+ # },
603
+ # next_token: "NextToken",
604
+ # max_results: 1,
605
+ # }
606
+ #
607
+ # @!attribute [rw] object_reference
608
+ # Reference of the object whose attributes need to be listed.
609
+ # @return [Types::ObjectReference]
610
+ #
611
+ # @!attribute [rw] next_token
612
+ # Token used for pagination.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] max_results
616
+ # Maximum number of items to be retrieved in a single call. This is an
617
+ # approximate number.
618
+ # @return [Integer]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectAttributes AWS API Documentation
621
+ #
622
+ class BatchListObjectAttributes < Struct.new(
623
+ :object_reference,
624
+ :next_token,
625
+ :max_results)
626
+ include Aws::Structure
627
+ end
628
+
629
+ # Represents the output of a ListObjectAttributes response operation.
630
+ #
631
+ # @!attribute [rw] attributes
632
+ # Attributes map associated with the object. AttributeArn is the key;
633
+ # attribute value is the value.
634
+ # @return [Array<Types::AttributeKeyAndValue>]
635
+ #
636
+ # @!attribute [rw] next_token
637
+ # Token used for pagination.
638
+ # @return [String]
639
+ #
640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectAttributesResponse AWS API Documentation
641
+ #
642
+ class BatchListObjectAttributesResponse < Struct.new(
643
+ :attributes,
644
+ :next_token)
645
+ include Aws::Structure
646
+ end
647
+
648
+ # Represents the output of a ListObjectChildren operation.
649
+ #
650
+ # @note When making an API call, you may pass BatchListObjectChildren
651
+ # data as a hash:
652
+ #
653
+ # {
654
+ # object_reference: { # required
655
+ # selector: "SelectorObjectReference",
656
+ # },
657
+ # next_token: "NextToken",
658
+ # max_results: 1,
659
+ # }
660
+ #
661
+ # @!attribute [rw] object_reference
662
+ # Reference of the object for which child objects are being listed.
663
+ # @return [Types::ObjectReference]
664
+ #
665
+ # @!attribute [rw] next_token
666
+ # Token used for pagination.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] max_results
670
+ # Maximum number of items to be retrieved in a single call. This is an
671
+ # approximate number.
672
+ # @return [Integer]
673
+ #
674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectChildren AWS API Documentation
675
+ #
676
+ class BatchListObjectChildren < Struct.new(
677
+ :object_reference,
678
+ :next_token,
679
+ :max_results)
680
+ include Aws::Structure
681
+ end
682
+
683
+ # Represents the output of a ListObjectChildren response operation.
684
+ #
685
+ # @!attribute [rw] children
686
+ # Children structure, which is a map with key as the LinkName and
687
+ # ObjectIdentifier as the value.
688
+ # @return [Hash<String,String>]
689
+ #
690
+ # @!attribute [rw] next_token
691
+ # Token used for pagination.
692
+ # @return [String]
693
+ #
694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectChildrenResponse AWS API Documentation
695
+ #
696
+ class BatchListObjectChildrenResponse < Struct.new(
697
+ :children,
698
+ :next_token)
699
+ include Aws::Structure
700
+ end
701
+
702
+ # Batch Read Exception structure, which contains exception type and
703
+ # message.
704
+ #
705
+ # @!attribute [rw] type
706
+ # Type of exception, such as InvalidArnException.
707
+ # @return [String]
708
+ #
709
+ # @!attribute [rw] message
710
+ # Exception message associated with the failure.
711
+ # @return [String]
712
+ #
713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadException AWS API Documentation
714
+ #
715
+ class BatchReadException < Struct.new(
716
+ :type,
717
+ :message)
718
+ include Aws::Structure
719
+ end
720
+
721
+ # Represents the output of a BatchRead operation.
722
+ #
723
+ # @note When making an API call, you may pass BatchReadOperation
724
+ # data as a hash:
725
+ #
726
+ # {
727
+ # list_object_attributes: {
728
+ # object_reference: { # required
729
+ # selector: "SelectorObjectReference",
730
+ # },
731
+ # next_token: "NextToken",
732
+ # max_results: 1,
733
+ # },
734
+ # list_object_children: {
735
+ # object_reference: { # required
736
+ # selector: "SelectorObjectReference",
737
+ # },
738
+ # next_token: "NextToken",
739
+ # max_results: 1,
740
+ # },
741
+ # }
742
+ #
743
+ # @!attribute [rw] list_object_attributes
744
+ # Lists all attributes associated with an object.
745
+ # @return [Types::BatchListObjectAttributes]
746
+ #
747
+ # @!attribute [rw] list_object_children
748
+ # Returns a paginated list of child objects that are associated with a
749
+ # given object.
750
+ # @return [Types::BatchListObjectChildren]
751
+ #
752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadOperation AWS API Documentation
753
+ #
754
+ class BatchReadOperation < Struct.new(
755
+ :list_object_attributes,
756
+ :list_object_children)
757
+ include Aws::Structure
758
+ end
759
+
760
+ # Represents the output of a BatchRead response operation.
761
+ #
762
+ # @!attribute [rw] successful_response
763
+ # Identifies which operation in a batch has succeeded.
764
+ # @return [Types::BatchReadSuccessfulResponse]
765
+ #
766
+ # @!attribute [rw] exception_response
767
+ # Identifies which operation in a batch has failed.
768
+ # @return [Types::BatchReadException]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadOperationResponse AWS API Documentation
771
+ #
772
+ class BatchReadOperationResponse < Struct.new(
773
+ :successful_response,
774
+ :exception_response)
775
+ include Aws::Structure
776
+ end
777
+
778
+ # @note When making an API call, you may pass BatchReadRequest
779
+ # data as a hash:
780
+ #
781
+ # {
782
+ # directory_arn: "Arn", # required
783
+ # operations: [ # required
784
+ # {
785
+ # list_object_attributes: {
786
+ # object_reference: { # required
787
+ # selector: "SelectorObjectReference",
788
+ # },
789
+ # next_token: "NextToken",
790
+ # max_results: 1,
791
+ # },
792
+ # list_object_children: {
793
+ # object_reference: { # required
794
+ # selector: "SelectorObjectReference",
795
+ # },
796
+ # next_token: "NextToken",
797
+ # max_results: 1,
798
+ # },
799
+ # },
800
+ # ],
801
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
802
+ # }
803
+ #
804
+ # @!attribute [rw] directory_arn
805
+ # ARN associated with the Directory. For more information, see arns.
806
+ # @return [String]
807
+ #
808
+ # @!attribute [rw] operations
809
+ # List of operations that are part of the batch.
810
+ # @return [Array<Types::BatchReadOperation>]
811
+ #
812
+ # @!attribute [rw] consistency_level
813
+ # Represents the manner and timing in which the successful write or
814
+ # update of an object is reflected in a subsequent read operation of
815
+ # that same object.
816
+ # @return [String]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadRequest AWS API Documentation
819
+ #
820
+ class BatchReadRequest < Struct.new(
821
+ :directory_arn,
822
+ :operations,
823
+ :consistency_level)
824
+ include Aws::Structure
825
+ end
826
+
827
+ # @!attribute [rw] responses
828
+ # List of all the responses for each batch read.
829
+ # @return [Array<Types::BatchReadOperationResponse>]
830
+ #
831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadResponse AWS API Documentation
832
+ #
833
+ class BatchReadResponse < Struct.new(
834
+ :responses)
835
+ include Aws::Structure
836
+ end
837
+
838
+ # Represents the output of a BatchRead success response operation.
839
+ #
840
+ # @!attribute [rw] list_object_attributes
841
+ # Lists all attributes associated with an object.
842
+ # @return [Types::BatchListObjectAttributesResponse]
843
+ #
844
+ # @!attribute [rw] list_object_children
845
+ # Returns a paginated list of child objects associated with a given
846
+ # object.
847
+ # @return [Types::BatchListObjectChildrenResponse]
848
+ #
849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadSuccessfulResponse AWS API Documentation
850
+ #
851
+ class BatchReadSuccessfulResponse < Struct.new(
852
+ :list_object_attributes,
853
+ :list_object_children)
854
+ include Aws::Structure
855
+ end
856
+
857
+ # Batch operation to remove a facet from an object.
858
+ #
859
+ # @note When making an API call, you may pass BatchRemoveFacetFromObject
860
+ # data as a hash:
861
+ #
862
+ # {
863
+ # schema_facet: { # required
864
+ # schema_arn: "Arn",
865
+ # facet_name: "FacetName",
866
+ # },
867
+ # object_reference: { # required
868
+ # selector: "SelectorObjectReference",
869
+ # },
870
+ # }
871
+ #
872
+ # @!attribute [rw] schema_facet
873
+ # The facet to remove from the object.
874
+ # @return [Types::SchemaFacet]
875
+ #
876
+ # @!attribute [rw] object_reference
877
+ # A reference to the object whose facet will be removed.
878
+ # @return [Types::ObjectReference]
879
+ #
880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRemoveFacetFromObject AWS API Documentation
881
+ #
882
+ class BatchRemoveFacetFromObject < Struct.new(
883
+ :schema_facet,
884
+ :object_reference)
885
+ include Aws::Structure
886
+ end
887
+
888
+ # Empty result representing success.
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRemoveFacetFromObjectResponse AWS API Documentation
891
+ #
892
+ class BatchRemoveFacetFromObjectResponse < Aws::EmptyStructure; end
893
+
894
+ # Represents the output of a BatchUpdate operation.
895
+ #
896
+ # @note When making an API call, you may pass BatchUpdateObjectAttributes
897
+ # data as a hash:
898
+ #
899
+ # {
900
+ # object_reference: { # required
901
+ # selector: "SelectorObjectReference",
902
+ # },
903
+ # attribute_updates: [ # required
904
+ # {
905
+ # object_attribute_key: {
906
+ # schema_arn: "Arn", # required
907
+ # facet_name: "FacetName", # required
908
+ # name: "AttributeName", # required
909
+ # },
910
+ # object_attribute_action: {
911
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
912
+ # object_attribute_update_value: {
913
+ # string_value: "StringAttributeValue",
914
+ # binary_value: "data",
915
+ # boolean_value: false,
916
+ # number_value: "NumberAttributeValue",
917
+ # datetime_value: Time.now,
918
+ # },
919
+ # },
920
+ # },
921
+ # ],
922
+ # }
923
+ #
924
+ # @!attribute [rw] object_reference
925
+ # Reference that identifies the object.
926
+ # @return [Types::ObjectReference]
927
+ #
928
+ # @!attribute [rw] attribute_updates
929
+ # Attributes update structure.
930
+ # @return [Array<Types::ObjectAttributeUpdate>]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchUpdateObjectAttributes AWS API Documentation
933
+ #
934
+ class BatchUpdateObjectAttributes < Struct.new(
935
+ :object_reference,
936
+ :attribute_updates)
937
+ include Aws::Structure
938
+ end
939
+
940
+ # Represents the output of a BatchUpdate response operation.
941
+ #
942
+ # @!attribute [rw] object_identifier
943
+ # ID associated with the object.
944
+ # @return [String]
945
+ #
946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchUpdateObjectAttributesResponse AWS API Documentation
947
+ #
948
+ class BatchUpdateObjectAttributesResponse < Struct.new(
949
+ :object_identifier)
950
+ include Aws::Structure
951
+ end
952
+
953
+ # Represents the output of a BatchWrite operation.
954
+ #
955
+ # @note When making an API call, you may pass BatchWriteOperation
956
+ # data as a hash:
957
+ #
958
+ # {
959
+ # create_object: {
960
+ # schema_facet: [ # required
961
+ # {
962
+ # schema_arn: "Arn",
963
+ # facet_name: "FacetName",
964
+ # },
965
+ # ],
966
+ # object_attribute_list: [ # required
967
+ # {
968
+ # key: { # required
969
+ # schema_arn: "Arn", # required
970
+ # facet_name: "FacetName", # required
971
+ # name: "AttributeName", # required
972
+ # },
973
+ # value: { # required
974
+ # string_value: "StringAttributeValue",
975
+ # binary_value: "data",
976
+ # boolean_value: false,
977
+ # number_value: "NumberAttributeValue",
978
+ # datetime_value: Time.now,
979
+ # },
980
+ # },
981
+ # ],
982
+ # parent_reference: { # required
983
+ # selector: "SelectorObjectReference",
984
+ # },
985
+ # link_name: "LinkName", # required
986
+ # batch_reference_name: "BatchReferenceName", # required
987
+ # },
988
+ # attach_object: {
989
+ # parent_reference: { # required
990
+ # selector: "SelectorObjectReference",
991
+ # },
992
+ # child_reference: { # required
993
+ # selector: "SelectorObjectReference",
994
+ # },
995
+ # link_name: "LinkName", # required
996
+ # },
997
+ # detach_object: {
998
+ # parent_reference: { # required
999
+ # selector: "SelectorObjectReference",
1000
+ # },
1001
+ # link_name: "LinkName", # required
1002
+ # batch_reference_name: "BatchReferenceName", # required
1003
+ # },
1004
+ # update_object_attributes: {
1005
+ # object_reference: { # required
1006
+ # selector: "SelectorObjectReference",
1007
+ # },
1008
+ # attribute_updates: [ # required
1009
+ # {
1010
+ # object_attribute_key: {
1011
+ # schema_arn: "Arn", # required
1012
+ # facet_name: "FacetName", # required
1013
+ # name: "AttributeName", # required
1014
+ # },
1015
+ # object_attribute_action: {
1016
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
1017
+ # object_attribute_update_value: {
1018
+ # string_value: "StringAttributeValue",
1019
+ # binary_value: "data",
1020
+ # boolean_value: false,
1021
+ # number_value: "NumberAttributeValue",
1022
+ # datetime_value: Time.now,
1023
+ # },
1024
+ # },
1025
+ # },
1026
+ # ],
1027
+ # },
1028
+ # delete_object: {
1029
+ # object_reference: { # required
1030
+ # selector: "SelectorObjectReference",
1031
+ # },
1032
+ # },
1033
+ # add_facet_to_object: {
1034
+ # schema_facet: { # required
1035
+ # schema_arn: "Arn",
1036
+ # facet_name: "FacetName",
1037
+ # },
1038
+ # object_attribute_list: [ # required
1039
+ # {
1040
+ # key: { # required
1041
+ # schema_arn: "Arn", # required
1042
+ # facet_name: "FacetName", # required
1043
+ # name: "AttributeName", # required
1044
+ # },
1045
+ # value: { # required
1046
+ # string_value: "StringAttributeValue",
1047
+ # binary_value: "data",
1048
+ # boolean_value: false,
1049
+ # number_value: "NumberAttributeValue",
1050
+ # datetime_value: Time.now,
1051
+ # },
1052
+ # },
1053
+ # ],
1054
+ # object_reference: { # required
1055
+ # selector: "SelectorObjectReference",
1056
+ # },
1057
+ # },
1058
+ # remove_facet_from_object: {
1059
+ # schema_facet: { # required
1060
+ # schema_arn: "Arn",
1061
+ # facet_name: "FacetName",
1062
+ # },
1063
+ # object_reference: { # required
1064
+ # selector: "SelectorObjectReference",
1065
+ # },
1066
+ # },
1067
+ # }
1068
+ #
1069
+ # @!attribute [rw] create_object
1070
+ # Creates an object.
1071
+ # @return [Types::BatchCreateObject]
1072
+ #
1073
+ # @!attribute [rw] attach_object
1074
+ # Attaches an object to a Directory.
1075
+ # @return [Types::BatchAttachObject]
1076
+ #
1077
+ # @!attribute [rw] detach_object
1078
+ # Detaches an object from a Directory.
1079
+ # @return [Types::BatchDetachObject]
1080
+ #
1081
+ # @!attribute [rw] update_object_attributes
1082
+ # Update a given object's attributes.
1083
+ # @return [Types::BatchUpdateObjectAttributes]
1084
+ #
1085
+ # @!attribute [rw] delete_object
1086
+ # Deletes an object in a Directory.
1087
+ # @return [Types::BatchDeleteObject]
1088
+ #
1089
+ # @!attribute [rw] add_facet_to_object
1090
+ # Batch operation adding a facet to an object.
1091
+ # @return [Types::BatchAddFacetToObject]
1092
+ #
1093
+ # @!attribute [rw] remove_facet_from_object
1094
+ # Batch operation removing a facet from an object.
1095
+ # @return [Types::BatchRemoveFacetFromObject]
1096
+ #
1097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperation AWS API Documentation
1098
+ #
1099
+ class BatchWriteOperation < Struct.new(
1100
+ :create_object,
1101
+ :attach_object,
1102
+ :detach_object,
1103
+ :update_object_attributes,
1104
+ :delete_object,
1105
+ :add_facet_to_object,
1106
+ :remove_facet_from_object)
1107
+ include Aws::Structure
1108
+ end
1109
+
1110
+ # Represents the output of a BatchWrite response operation.
1111
+ #
1112
+ # @!attribute [rw] create_object
1113
+ # Creates an object in a Directory.
1114
+ # @return [Types::BatchCreateObjectResponse]
1115
+ #
1116
+ # @!attribute [rw] attach_object
1117
+ # Attaches an object to a Directory.
1118
+ # @return [Types::BatchAttachObjectResponse]
1119
+ #
1120
+ # @!attribute [rw] detach_object
1121
+ # Detaches an object from a Directory.
1122
+ # @return [Types::BatchDetachObjectResponse]
1123
+ #
1124
+ # @!attribute [rw] update_object_attributes
1125
+ # Updates a given object’s attributes.
1126
+ # @return [Types::BatchUpdateObjectAttributesResponse]
1127
+ #
1128
+ # @!attribute [rw] delete_object
1129
+ # Deletes an object in a Directory.
1130
+ # @return [Types::BatchDeleteObjectResponse]
1131
+ #
1132
+ # @!attribute [rw] add_facet_to_object
1133
+ # Result of an add facet to object batch operation.
1134
+ # @return [Types::BatchAddFacetToObjectResponse]
1135
+ #
1136
+ # @!attribute [rw] remove_facet_from_object
1137
+ # Result of a batch remove facet from object operation.
1138
+ # @return [Types::BatchRemoveFacetFromObjectResponse]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperationResponse AWS API Documentation
1141
+ #
1142
+ class BatchWriteOperationResponse < Struct.new(
1143
+ :create_object,
1144
+ :attach_object,
1145
+ :detach_object,
1146
+ :update_object_attributes,
1147
+ :delete_object,
1148
+ :add_facet_to_object,
1149
+ :remove_facet_from_object)
1150
+ include Aws::Structure
1151
+ end
1152
+
1153
+ # @note When making an API call, you may pass BatchWriteRequest
1154
+ # data as a hash:
1155
+ #
1156
+ # {
1157
+ # directory_arn: "Arn", # required
1158
+ # operations: [ # required
1159
+ # {
1160
+ # create_object: {
1161
+ # schema_facet: [ # required
1162
+ # {
1163
+ # schema_arn: "Arn",
1164
+ # facet_name: "FacetName",
1165
+ # },
1166
+ # ],
1167
+ # object_attribute_list: [ # required
1168
+ # {
1169
+ # key: { # required
1170
+ # schema_arn: "Arn", # required
1171
+ # facet_name: "FacetName", # required
1172
+ # name: "AttributeName", # required
1173
+ # },
1174
+ # value: { # required
1175
+ # string_value: "StringAttributeValue",
1176
+ # binary_value: "data",
1177
+ # boolean_value: false,
1178
+ # number_value: "NumberAttributeValue",
1179
+ # datetime_value: Time.now,
1180
+ # },
1181
+ # },
1182
+ # ],
1183
+ # parent_reference: { # required
1184
+ # selector: "SelectorObjectReference",
1185
+ # },
1186
+ # link_name: "LinkName", # required
1187
+ # batch_reference_name: "BatchReferenceName", # required
1188
+ # },
1189
+ # attach_object: {
1190
+ # parent_reference: { # required
1191
+ # selector: "SelectorObjectReference",
1192
+ # },
1193
+ # child_reference: { # required
1194
+ # selector: "SelectorObjectReference",
1195
+ # },
1196
+ # link_name: "LinkName", # required
1197
+ # },
1198
+ # detach_object: {
1199
+ # parent_reference: { # required
1200
+ # selector: "SelectorObjectReference",
1201
+ # },
1202
+ # link_name: "LinkName", # required
1203
+ # batch_reference_name: "BatchReferenceName", # required
1204
+ # },
1205
+ # update_object_attributes: {
1206
+ # object_reference: { # required
1207
+ # selector: "SelectorObjectReference",
1208
+ # },
1209
+ # attribute_updates: [ # required
1210
+ # {
1211
+ # object_attribute_key: {
1212
+ # schema_arn: "Arn", # required
1213
+ # facet_name: "FacetName", # required
1214
+ # name: "AttributeName", # required
1215
+ # },
1216
+ # object_attribute_action: {
1217
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
1218
+ # object_attribute_update_value: {
1219
+ # string_value: "StringAttributeValue",
1220
+ # binary_value: "data",
1221
+ # boolean_value: false,
1222
+ # number_value: "NumberAttributeValue",
1223
+ # datetime_value: Time.now,
1224
+ # },
1225
+ # },
1226
+ # },
1227
+ # ],
1228
+ # },
1229
+ # delete_object: {
1230
+ # object_reference: { # required
1231
+ # selector: "SelectorObjectReference",
1232
+ # },
1233
+ # },
1234
+ # add_facet_to_object: {
1235
+ # schema_facet: { # required
1236
+ # schema_arn: "Arn",
1237
+ # facet_name: "FacetName",
1238
+ # },
1239
+ # object_attribute_list: [ # required
1240
+ # {
1241
+ # key: { # required
1242
+ # schema_arn: "Arn", # required
1243
+ # facet_name: "FacetName", # required
1244
+ # name: "AttributeName", # required
1245
+ # },
1246
+ # value: { # required
1247
+ # string_value: "StringAttributeValue",
1248
+ # binary_value: "data",
1249
+ # boolean_value: false,
1250
+ # number_value: "NumberAttributeValue",
1251
+ # datetime_value: Time.now,
1252
+ # },
1253
+ # },
1254
+ # ],
1255
+ # object_reference: { # required
1256
+ # selector: "SelectorObjectReference",
1257
+ # },
1258
+ # },
1259
+ # remove_facet_from_object: {
1260
+ # schema_facet: { # required
1261
+ # schema_arn: "Arn",
1262
+ # facet_name: "FacetName",
1263
+ # },
1264
+ # object_reference: { # required
1265
+ # selector: "SelectorObjectReference",
1266
+ # },
1267
+ # },
1268
+ # },
1269
+ # ],
1270
+ # }
1271
+ #
1272
+ # @!attribute [rw] directory_arn
1273
+ # ARN associated with the Directory. For more information, see arns.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] operations
1277
+ # List of operations that are part of the batch.
1278
+ # @return [Array<Types::BatchWriteOperation>]
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteRequest AWS API Documentation
1281
+ #
1282
+ class BatchWriteRequest < Struct.new(
1283
+ :directory_arn,
1284
+ :operations)
1285
+ include Aws::Structure
1286
+ end
1287
+
1288
+ # @!attribute [rw] responses
1289
+ # List of all the responses for each batch write.
1290
+ # @return [Array<Types::BatchWriteOperationResponse>]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteResponse AWS API Documentation
1293
+ #
1294
+ class BatchWriteResponse < Struct.new(
1295
+ :responses)
1296
+ include Aws::Structure
1297
+ end
1298
+
1299
+ # @note When making an API call, you may pass CreateDirectoryRequest
1300
+ # data as a hash:
1301
+ #
1302
+ # {
1303
+ # name: "DirectoryName", # required
1304
+ # schema_arn: "Arn", # required
1305
+ # }
1306
+ #
1307
+ # @!attribute [rw] name
1308
+ # Name of the Directory. Should be unique per account, per region.
1309
+ # @return [String]
1310
+ #
1311
+ # @!attribute [rw] schema_arn
1312
+ # ARN of the published schema that will be copied into the data
1313
+ # Directory. For more information, see arns.
1314
+ # @return [String]
1315
+ #
1316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectoryRequest AWS API Documentation
1317
+ #
1318
+ class CreateDirectoryRequest < Struct.new(
1319
+ :name,
1320
+ :schema_arn)
1321
+ include Aws::Structure
1322
+ end
1323
+
1324
+ # @!attribute [rw] directory_arn
1325
+ # ARN associated with the Directory. For more information, see arns.
1326
+ # @return [String]
1327
+ #
1328
+ # @!attribute [rw] name
1329
+ # Name of the Directory.
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] object_identifier
1333
+ # The root object node of the created directory.
1334
+ # @return [String]
1335
+ #
1336
+ # @!attribute [rw] applied_schema_arn
1337
+ # ARN of the published schema in the Directory. Once a published
1338
+ # schema is copied into the directory, it has its own ARN which is
1339
+ # referred to applied schema ARN. For more information, see arns.
1340
+ # @return [String]
1341
+ #
1342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectoryResponse AWS API Documentation
1343
+ #
1344
+ class CreateDirectoryResponse < Struct.new(
1345
+ :directory_arn,
1346
+ :name,
1347
+ :object_identifier,
1348
+ :applied_schema_arn)
1349
+ include Aws::Structure
1350
+ end
1351
+
1352
+ # @note When making an API call, you may pass CreateFacetRequest
1353
+ # data as a hash:
1354
+ #
1355
+ # {
1356
+ # schema_arn: "Arn", # required
1357
+ # name: "FacetName", # required
1358
+ # attributes: [
1359
+ # {
1360
+ # name: "AttributeName", # required
1361
+ # attribute_definition: {
1362
+ # type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
1363
+ # default_value: {
1364
+ # string_value: "StringAttributeValue",
1365
+ # binary_value: "data",
1366
+ # boolean_value: false,
1367
+ # number_value: "NumberAttributeValue",
1368
+ # datetime_value: Time.now,
1369
+ # },
1370
+ # is_immutable: false,
1371
+ # rules: {
1372
+ # "RuleKey" => {
1373
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
1374
+ # parameters: {
1375
+ # "RuleParameterKey" => "RuleParameterValue",
1376
+ # },
1377
+ # },
1378
+ # },
1379
+ # },
1380
+ # attribute_reference: {
1381
+ # target_facet_name: "FacetName", # required
1382
+ # target_attribute_name: "AttributeName", # required
1383
+ # },
1384
+ # required_behavior: "REQUIRED_ALWAYS", # accepts REQUIRED_ALWAYS, NOT_REQUIRED
1385
+ # },
1386
+ # ],
1387
+ # object_type: "NODE", # required, accepts NODE, LEAF_NODE, POLICY, INDEX
1388
+ # }
1389
+ #
1390
+ # @!attribute [rw] schema_arn
1391
+ # Schema ARN in which the new Facet will be created. For more
1392
+ # information, see arns.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] name
1396
+ # Name of the Facet, which is unique for a given schema.
1397
+ # @return [String]
1398
+ #
1399
+ # @!attribute [rw] attributes
1400
+ # Attributes associated with the Facet.e
1401
+ # @return [Array<Types::FacetAttribute>]
1402
+ #
1403
+ # @!attribute [rw] object_type
1404
+ # Specifies whether a given object created from this facet is of type
1405
+ # Node, Leaf Node, Policy or Index.
1406
+ #
1407
+ # * Node: Can have multiple children but one parent.
1408
+ #
1409
+ # ^
1410
+ # ^
1411
+ #
1412
+ # * Leaf Node: Cannot have children but can have multiple parents.
1413
+ #
1414
+ # ^
1415
+ # ^
1416
+ #
1417
+ # * Policy: Allows you to store a policy document and policy type. For
1418
+ # more information, see [Policies][1].
1419
+ #
1420
+ # ^
1421
+ # ^
1422
+ #
1423
+ # * Index: Can be created with the Index API.
1424
+ #
1425
+ # ^
1426
+ #
1427
+ #
1428
+ #
1429
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies
1430
+ # @return [String]
1431
+ #
1432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateFacetRequest AWS API Documentation
1433
+ #
1434
+ class CreateFacetRequest < Struct.new(
1435
+ :schema_arn,
1436
+ :name,
1437
+ :attributes,
1438
+ :object_type)
1439
+ include Aws::Structure
1440
+ end
1441
+
1442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateFacetResponse AWS API Documentation
1443
+ #
1444
+ class CreateFacetResponse < Aws::EmptyStructure; end
1445
+
1446
+ # @note When making an API call, you may pass CreateIndexRequest
1447
+ # data as a hash:
1448
+ #
1449
+ # {
1450
+ # directory_arn: "Arn", # required
1451
+ # ordered_indexed_attribute_list: [ # required
1452
+ # {
1453
+ # schema_arn: "Arn", # required
1454
+ # facet_name: "FacetName", # required
1455
+ # name: "AttributeName", # required
1456
+ # },
1457
+ # ],
1458
+ # is_unique: false, # required
1459
+ # parent_reference: {
1460
+ # selector: "SelectorObjectReference",
1461
+ # },
1462
+ # link_name: "LinkName",
1463
+ # }
1464
+ #
1465
+ # @!attribute [rw] directory_arn
1466
+ # The ARN of the directory where the index should be created.
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] ordered_indexed_attribute_list
1470
+ # Specifies the Attributes that should be indexed on. Currently only a
1471
+ # single attribute is supported.
1472
+ # @return [Array<Types::AttributeKey>]
1473
+ #
1474
+ # @!attribute [rw] is_unique
1475
+ # Indicates whether objects with the same indexed attribute value can
1476
+ # be added to the index.
1477
+ # @return [Boolean]
1478
+ #
1479
+ # @!attribute [rw] parent_reference
1480
+ # A reference to the parent object that contains the index object.
1481
+ # @return [Types::ObjectReference]
1482
+ #
1483
+ # @!attribute [rw] link_name
1484
+ # The name of the link between the parent object and the index object.
1485
+ # @return [String]
1486
+ #
1487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateIndexRequest AWS API Documentation
1488
+ #
1489
+ class CreateIndexRequest < Struct.new(
1490
+ :directory_arn,
1491
+ :ordered_indexed_attribute_list,
1492
+ :is_unique,
1493
+ :parent_reference,
1494
+ :link_name)
1495
+ include Aws::Structure
1496
+ end
1497
+
1498
+ # @!attribute [rw] object_identifier
1499
+ # The ObjectIdentifier of the index created by this operation.
1500
+ # @return [String]
1501
+ #
1502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateIndexResponse AWS API Documentation
1503
+ #
1504
+ class CreateIndexResponse < Struct.new(
1505
+ :object_identifier)
1506
+ include Aws::Structure
1507
+ end
1508
+
1509
+ # @note When making an API call, you may pass CreateObjectRequest
1510
+ # data as a hash:
1511
+ #
1512
+ # {
1513
+ # directory_arn: "Arn", # required
1514
+ # schema_facets: [ # required
1515
+ # {
1516
+ # schema_arn: "Arn",
1517
+ # facet_name: "FacetName",
1518
+ # },
1519
+ # ],
1520
+ # object_attribute_list: [
1521
+ # {
1522
+ # key: { # required
1523
+ # schema_arn: "Arn", # required
1524
+ # facet_name: "FacetName", # required
1525
+ # name: "AttributeName", # required
1526
+ # },
1527
+ # value: { # required
1528
+ # string_value: "StringAttributeValue",
1529
+ # binary_value: "data",
1530
+ # boolean_value: false,
1531
+ # number_value: "NumberAttributeValue",
1532
+ # datetime_value: Time.now,
1533
+ # },
1534
+ # },
1535
+ # ],
1536
+ # parent_reference: {
1537
+ # selector: "SelectorObjectReference",
1538
+ # },
1539
+ # link_name: "LinkName",
1540
+ # }
1541
+ #
1542
+ # @!attribute [rw] directory_arn
1543
+ # ARN associated with the Directory in which the object will be
1544
+ # created. For more information, see arns.
1545
+ # @return [String]
1546
+ #
1547
+ # @!attribute [rw] schema_facets
1548
+ # List of facet ARNs to be associated with the object. For more
1549
+ # information, see arns.
1550
+ # @return [Array<Types::SchemaFacet>]
1551
+ #
1552
+ # @!attribute [rw] object_attribute_list
1553
+ # Attribute map whose attribute ARN contains the key and attribute
1554
+ # value as the map value.
1555
+ # @return [Array<Types::AttributeKeyAndValue>]
1556
+ #
1557
+ # @!attribute [rw] parent_reference
1558
+ # If specified, the parent reference to which this object will be
1559
+ # attached.
1560
+ # @return [Types::ObjectReference]
1561
+ #
1562
+ # @!attribute [rw] link_name
1563
+ # The name of link that is used to attach this object to a parent.
1564
+ # @return [String]
1565
+ #
1566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObjectRequest AWS API Documentation
1567
+ #
1568
+ class CreateObjectRequest < Struct.new(
1569
+ :directory_arn,
1570
+ :schema_facets,
1571
+ :object_attribute_list,
1572
+ :parent_reference,
1573
+ :link_name)
1574
+ include Aws::Structure
1575
+ end
1576
+
1577
+ # @!attribute [rw] object_identifier
1578
+ # Identifier associated with the object.
1579
+ # @return [String]
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObjectResponse AWS API Documentation
1582
+ #
1583
+ class CreateObjectResponse < Struct.new(
1584
+ :object_identifier)
1585
+ include Aws::Structure
1586
+ end
1587
+
1588
+ # @note When making an API call, you may pass CreateSchemaRequest
1589
+ # data as a hash:
1590
+ #
1591
+ # {
1592
+ # name: "SchemaName", # required
1593
+ # }
1594
+ #
1595
+ # @!attribute [rw] name
1596
+ # Name associated with the schema. This is unique to each account and
1597
+ # in each region.
1598
+ # @return [String]
1599
+ #
1600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaRequest AWS API Documentation
1601
+ #
1602
+ class CreateSchemaRequest < Struct.new(
1603
+ :name)
1604
+ include Aws::Structure
1605
+ end
1606
+
1607
+ # @!attribute [rw] schema_arn
1608
+ # ARN associated with the schema. For more information, see arns.
1609
+ # @return [String]
1610
+ #
1611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaResponse AWS API Documentation
1612
+ #
1613
+ class CreateSchemaResponse < Struct.new(
1614
+ :schema_arn)
1615
+ include Aws::Structure
1616
+ end
1617
+
1618
+ # @note When making an API call, you may pass DeleteDirectoryRequest
1619
+ # data as a hash:
1620
+ #
1621
+ # {
1622
+ # directory_arn: "Arn", # required
1623
+ # }
1624
+ #
1625
+ # @!attribute [rw] directory_arn
1626
+ # The ARN of the directory to delete.
1627
+ # @return [String]
1628
+ #
1629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteDirectoryRequest AWS API Documentation
1630
+ #
1631
+ class DeleteDirectoryRequest < Struct.new(
1632
+ :directory_arn)
1633
+ include Aws::Structure
1634
+ end
1635
+
1636
+ # @!attribute [rw] directory_arn
1637
+ # The ARN of the deleted directory.
1638
+ # @return [String]
1639
+ #
1640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteDirectoryResponse AWS API Documentation
1641
+ #
1642
+ class DeleteDirectoryResponse < Struct.new(
1643
+ :directory_arn)
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # @note When making an API call, you may pass DeleteFacetRequest
1648
+ # data as a hash:
1649
+ #
1650
+ # {
1651
+ # schema_arn: "Arn", # required
1652
+ # name: "FacetName", # required
1653
+ # }
1654
+ #
1655
+ # @!attribute [rw] schema_arn
1656
+ # ARN associated with the Facet. For more information, see arns.
1657
+ # @return [String]
1658
+ #
1659
+ # @!attribute [rw] name
1660
+ # The name of the facet to delete.
1661
+ # @return [String]
1662
+ #
1663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteFacetRequest AWS API Documentation
1664
+ #
1665
+ class DeleteFacetRequest < Struct.new(
1666
+ :schema_arn,
1667
+ :name)
1668
+ include Aws::Structure
1669
+ end
1670
+
1671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteFacetResponse AWS API Documentation
1672
+ #
1673
+ class DeleteFacetResponse < Aws::EmptyStructure; end
1674
+
1675
+ # @note When making an API call, you may pass DeleteObjectRequest
1676
+ # data as a hash:
1677
+ #
1678
+ # {
1679
+ # directory_arn: "Arn", # required
1680
+ # object_reference: { # required
1681
+ # selector: "SelectorObjectReference",
1682
+ # },
1683
+ # }
1684
+ #
1685
+ # @!attribute [rw] directory_arn
1686
+ # ARN associated with the Directory where the object resides. For more
1687
+ # information, see arns.
1688
+ # @return [String]
1689
+ #
1690
+ # @!attribute [rw] object_reference
1691
+ # Reference that identifies the object.
1692
+ # @return [Types::ObjectReference]
1693
+ #
1694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObjectRequest AWS API Documentation
1695
+ #
1696
+ class DeleteObjectRequest < Struct.new(
1697
+ :directory_arn,
1698
+ :object_reference)
1699
+ include Aws::Structure
1700
+ end
1701
+
1702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObjectResponse AWS API Documentation
1703
+ #
1704
+ class DeleteObjectResponse < Aws::EmptyStructure; end
1705
+
1706
+ # @note When making an API call, you may pass DeleteSchemaRequest
1707
+ # data as a hash:
1708
+ #
1709
+ # {
1710
+ # schema_arn: "Arn", # required
1711
+ # }
1712
+ #
1713
+ # @!attribute [rw] schema_arn
1714
+ # ARN of the development schema. For more information, see arns.
1715
+ # @return [String]
1716
+ #
1717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchemaRequest AWS API Documentation
1718
+ #
1719
+ class DeleteSchemaRequest < Struct.new(
1720
+ :schema_arn)
1721
+ include Aws::Structure
1722
+ end
1723
+
1724
+ # @!attribute [rw] schema_arn
1725
+ # Input ARN that is returned as part of the response. For more
1726
+ # information, see arns.
1727
+ # @return [String]
1728
+ #
1729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchemaResponse AWS API Documentation
1730
+ #
1731
+ class DeleteSchemaResponse < Struct.new(
1732
+ :schema_arn)
1733
+ include Aws::Structure
1734
+ end
1735
+
1736
+ # @note When making an API call, you may pass DetachFromIndexRequest
1737
+ # data as a hash:
1738
+ #
1739
+ # {
1740
+ # directory_arn: "Arn", # required
1741
+ # index_reference: { # required
1742
+ # selector: "SelectorObjectReference",
1743
+ # },
1744
+ # target_reference: { # required
1745
+ # selector: "SelectorObjectReference",
1746
+ # },
1747
+ # }
1748
+ #
1749
+ # @!attribute [rw] directory_arn
1750
+ # The ARN of the directory the index and object exist in.
1751
+ # @return [String]
1752
+ #
1753
+ # @!attribute [rw] index_reference
1754
+ # A reference to the index object.
1755
+ # @return [Types::ObjectReference]
1756
+ #
1757
+ # @!attribute [rw] target_reference
1758
+ # A reference to the object being detached from the index.
1759
+ # @return [Types::ObjectReference]
1760
+ #
1761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachFromIndexRequest AWS API Documentation
1762
+ #
1763
+ class DetachFromIndexRequest < Struct.new(
1764
+ :directory_arn,
1765
+ :index_reference,
1766
+ :target_reference)
1767
+ include Aws::Structure
1768
+ end
1769
+
1770
+ # @!attribute [rw] detached_object_identifier
1771
+ # The ObjectIdentifier of the object that was detached from the index.
1772
+ # @return [String]
1773
+ #
1774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachFromIndexResponse AWS API Documentation
1775
+ #
1776
+ class DetachFromIndexResponse < Struct.new(
1777
+ :detached_object_identifier)
1778
+ include Aws::Structure
1779
+ end
1780
+
1781
+ # @note When making an API call, you may pass DetachObjectRequest
1782
+ # data as a hash:
1783
+ #
1784
+ # {
1785
+ # directory_arn: "Arn", # required
1786
+ # parent_reference: { # required
1787
+ # selector: "SelectorObjectReference",
1788
+ # },
1789
+ # link_name: "LinkName", # required
1790
+ # }
1791
+ #
1792
+ # @!attribute [rw] directory_arn
1793
+ # ARN associated with the Directory where objects reside. For more
1794
+ # information, see arns.
1795
+ # @return [String]
1796
+ #
1797
+ # @!attribute [rw] parent_reference
1798
+ # Parent reference from which the object with the specified link name
1799
+ # is detached.
1800
+ # @return [Types::ObjectReference]
1801
+ #
1802
+ # @!attribute [rw] link_name
1803
+ # Link name associated with the object that needs to be detached.
1804
+ # @return [String]
1805
+ #
1806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObjectRequest AWS API Documentation
1807
+ #
1808
+ class DetachObjectRequest < Struct.new(
1809
+ :directory_arn,
1810
+ :parent_reference,
1811
+ :link_name)
1812
+ include Aws::Structure
1813
+ end
1814
+
1815
+ # @!attribute [rw] detached_object_identifier
1816
+ # The ObjectIdentifier that was detached from the object.
1817
+ # @return [String]
1818
+ #
1819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObjectResponse AWS API Documentation
1820
+ #
1821
+ class DetachObjectResponse < Struct.new(
1822
+ :detached_object_identifier)
1823
+ include Aws::Structure
1824
+ end
1825
+
1826
+ # @note When making an API call, you may pass DetachPolicyRequest
1827
+ # data as a hash:
1828
+ #
1829
+ # {
1830
+ # directory_arn: "Arn", # required
1831
+ # policy_reference: { # required
1832
+ # selector: "SelectorObjectReference",
1833
+ # },
1834
+ # object_reference: { # required
1835
+ # selector: "SelectorObjectReference",
1836
+ # },
1837
+ # }
1838
+ #
1839
+ # @!attribute [rw] directory_arn
1840
+ # ARN associated with the Directory where both objects reside. For
1841
+ # more information, see arns.
1842
+ # @return [String]
1843
+ #
1844
+ # @!attribute [rw] policy_reference
1845
+ # Reference that identifies the policy object.
1846
+ # @return [Types::ObjectReference]
1847
+ #
1848
+ # @!attribute [rw] object_reference
1849
+ # Reference that identifies the object whose policy object will be
1850
+ # detached.
1851
+ # @return [Types::ObjectReference]
1852
+ #
1853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachPolicyRequest AWS API Documentation
1854
+ #
1855
+ class DetachPolicyRequest < Struct.new(
1856
+ :directory_arn,
1857
+ :policy_reference,
1858
+ :object_reference)
1859
+ include Aws::Structure
1860
+ end
1861
+
1862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachPolicyResponse AWS API Documentation
1863
+ #
1864
+ class DetachPolicyResponse < Aws::EmptyStructure; end
1865
+
1866
+ # Directory structure that includes the directory name and directory
1867
+ # ARN.
1868
+ #
1869
+ # @!attribute [rw] name
1870
+ # The name of the directory.
1871
+ # @return [String]
1872
+ #
1873
+ # @!attribute [rw] directory_arn
1874
+ # ARN associated with the directory. For more information, see arns.
1875
+ # @return [String]
1876
+ #
1877
+ # @!attribute [rw] state
1878
+ # The state of the directory. Can be either Enabled, Disabled, or
1879
+ # Deleted.
1880
+ # @return [String]
1881
+ #
1882
+ # @!attribute [rw] creation_date_time
1883
+ # The date and time when the directory was created.
1884
+ # @return [Time]
1885
+ #
1886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Directory AWS API Documentation
1887
+ #
1888
+ class Directory < Struct.new(
1889
+ :name,
1890
+ :directory_arn,
1891
+ :state,
1892
+ :creation_date_time)
1893
+ include Aws::Structure
1894
+ end
1895
+
1896
+ # @note When making an API call, you may pass DisableDirectoryRequest
1897
+ # data as a hash:
1898
+ #
1899
+ # {
1900
+ # directory_arn: "Arn", # required
1901
+ # }
1902
+ #
1903
+ # @!attribute [rw] directory_arn
1904
+ # The ARN of the directory to disable.
1905
+ # @return [String]
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DisableDirectoryRequest AWS API Documentation
1908
+ #
1909
+ class DisableDirectoryRequest < Struct.new(
1910
+ :directory_arn)
1911
+ include Aws::Structure
1912
+ end
1913
+
1914
+ # @!attribute [rw] directory_arn
1915
+ # The ARN of the directory that has been disabled.
1916
+ # @return [String]
1917
+ #
1918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DisableDirectoryResponse AWS API Documentation
1919
+ #
1920
+ class DisableDirectoryResponse < Struct.new(
1921
+ :directory_arn)
1922
+ include Aws::Structure
1923
+ end
1924
+
1925
+ # @note When making an API call, you may pass EnableDirectoryRequest
1926
+ # data as a hash:
1927
+ #
1928
+ # {
1929
+ # directory_arn: "Arn", # required
1930
+ # }
1931
+ #
1932
+ # @!attribute [rw] directory_arn
1933
+ # The ARN of the directory to enable.
1934
+ # @return [String]
1935
+ #
1936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/EnableDirectoryRequest AWS API Documentation
1937
+ #
1938
+ class EnableDirectoryRequest < Struct.new(
1939
+ :directory_arn)
1940
+ include Aws::Structure
1941
+ end
1942
+
1943
+ # @!attribute [rw] directory_arn
1944
+ # The ARN of the enabled directory.
1945
+ # @return [String]
1946
+ #
1947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/EnableDirectoryResponse AWS API Documentation
1948
+ #
1949
+ class EnableDirectoryResponse < Struct.new(
1950
+ :directory_arn)
1951
+ include Aws::Structure
1952
+ end
1953
+
1954
+ # A structure that contains Name, ARN, Attributes, Rules, and
1955
+ # ObjectTypes.
1956
+ #
1957
+ # @!attribute [rw] name
1958
+ # The name of the Facet.
1959
+ # @return [String]
1960
+ #
1961
+ # @!attribute [rw] object_type
1962
+ # Object type associated with the facet. See
1963
+ # CreateFacetRequest$ObjectType for more details.
1964
+ # @return [String]
1965
+ #
1966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Facet AWS API Documentation
1967
+ #
1968
+ class Facet < Struct.new(
1969
+ :name,
1970
+ :object_type)
1971
+ include Aws::Structure
1972
+ end
1973
+
1974
+ # Attribute associated with the Facet.
1975
+ #
1976
+ # @note When making an API call, you may pass FacetAttribute
1977
+ # data as a hash:
1978
+ #
1979
+ # {
1980
+ # name: "AttributeName", # required
1981
+ # attribute_definition: {
1982
+ # type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
1983
+ # default_value: {
1984
+ # string_value: "StringAttributeValue",
1985
+ # binary_value: "data",
1986
+ # boolean_value: false,
1987
+ # number_value: "NumberAttributeValue",
1988
+ # datetime_value: Time.now,
1989
+ # },
1990
+ # is_immutable: false,
1991
+ # rules: {
1992
+ # "RuleKey" => {
1993
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
1994
+ # parameters: {
1995
+ # "RuleParameterKey" => "RuleParameterValue",
1996
+ # },
1997
+ # },
1998
+ # },
1999
+ # },
2000
+ # attribute_reference: {
2001
+ # target_facet_name: "FacetName", # required
2002
+ # target_attribute_name: "AttributeName", # required
2003
+ # },
2004
+ # required_behavior: "REQUIRED_ALWAYS", # accepts REQUIRED_ALWAYS, NOT_REQUIRED
2005
+ # }
2006
+ #
2007
+ # @!attribute [rw] name
2008
+ # The name of the facet attribute.
2009
+ # @return [String]
2010
+ #
2011
+ # @!attribute [rw] attribute_definition
2012
+ # A facet attribute consists of either a definition or a reference.
2013
+ # This structure contains the attribute definition. See [Attribute
2014
+ # References][1] for more information.
2015
+ #
2016
+ #
2017
+ #
2018
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences
2019
+ # @return [Types::FacetAttributeDefinition]
2020
+ #
2021
+ # @!attribute [rw] attribute_reference
2022
+ # Attribute reference associated with the attribute. See [Attribute
2023
+ # References][1] for more information.
2024
+ #
2025
+ #
2026
+ #
2027
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences
2028
+ # @return [Types::FacetAttributeReference]
2029
+ #
2030
+ # @!attribute [rw] required_behavior
2031
+ # The required behavior of the FacetAttribute.
2032
+ # @return [String]
2033
+ #
2034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttribute AWS API Documentation
2035
+ #
2036
+ class FacetAttribute < Struct.new(
2037
+ :name,
2038
+ :attribute_definition,
2039
+ :attribute_reference,
2040
+ :required_behavior)
2041
+ include Aws::Structure
2042
+ end
2043
+
2044
+ # A facet attribute definition. See [Attribute References][1] for more
2045
+ # information.
2046
+ #
2047
+ #
2048
+ #
2049
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences
2050
+ #
2051
+ # @note When making an API call, you may pass FacetAttributeDefinition
2052
+ # data as a hash:
2053
+ #
2054
+ # {
2055
+ # type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
2056
+ # default_value: {
2057
+ # string_value: "StringAttributeValue",
2058
+ # binary_value: "data",
2059
+ # boolean_value: false,
2060
+ # number_value: "NumberAttributeValue",
2061
+ # datetime_value: Time.now,
2062
+ # },
2063
+ # is_immutable: false,
2064
+ # rules: {
2065
+ # "RuleKey" => {
2066
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
2067
+ # parameters: {
2068
+ # "RuleParameterKey" => "RuleParameterValue",
2069
+ # },
2070
+ # },
2071
+ # },
2072
+ # }
2073
+ #
2074
+ # @!attribute [rw] type
2075
+ # The type of the attribute.
2076
+ # @return [String]
2077
+ #
2078
+ # @!attribute [rw] default_value
2079
+ # The default value of the attribute (if configured).
2080
+ # @return [Types::TypedAttributeValue]
2081
+ #
2082
+ # @!attribute [rw] is_immutable
2083
+ # Whether the attribute is mutable or not.
2084
+ # @return [Boolean]
2085
+ #
2086
+ # @!attribute [rw] rules
2087
+ # Validation rules attached to the attribute definition.
2088
+ # @return [Hash<String,Types::Rule>]
2089
+ #
2090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeDefinition AWS API Documentation
2091
+ #
2092
+ class FacetAttributeDefinition < Struct.new(
2093
+ :type,
2094
+ :default_value,
2095
+ :is_immutable,
2096
+ :rules)
2097
+ include Aws::Structure
2098
+ end
2099
+
2100
+ # Facet attribute reference that specifies the attribute definition
2101
+ # which contains attribute facet name and attribute name.
2102
+ #
2103
+ # @note When making an API call, you may pass FacetAttributeReference
2104
+ # data as a hash:
2105
+ #
2106
+ # {
2107
+ # target_facet_name: "FacetName", # required
2108
+ # target_attribute_name: "AttributeName", # required
2109
+ # }
2110
+ #
2111
+ # @!attribute [rw] target_facet_name
2112
+ # Target facet name associated with the facet reference. See
2113
+ # [Attribute References][1] for more information.
2114
+ #
2115
+ #
2116
+ #
2117
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences
2118
+ # @return [String]
2119
+ #
2120
+ # @!attribute [rw] target_attribute_name
2121
+ # Target attribute name associated with the facet reference. See
2122
+ # [Attribute References][1] for more information.
2123
+ #
2124
+ #
2125
+ #
2126
+ # [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences
2127
+ # @return [String]
2128
+ #
2129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeReference AWS API Documentation
2130
+ #
2131
+ class FacetAttributeReference < Struct.new(
2132
+ :target_facet_name,
2133
+ :target_attribute_name)
2134
+ include Aws::Structure
2135
+ end
2136
+
2137
+ # A structure that contains information used to update an attribute.
2138
+ #
2139
+ # @note When making an API call, you may pass FacetAttributeUpdate
2140
+ # data as a hash:
2141
+ #
2142
+ # {
2143
+ # attribute: {
2144
+ # name: "AttributeName", # required
2145
+ # attribute_definition: {
2146
+ # type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
2147
+ # default_value: {
2148
+ # string_value: "StringAttributeValue",
2149
+ # binary_value: "data",
2150
+ # boolean_value: false,
2151
+ # number_value: "NumberAttributeValue",
2152
+ # datetime_value: Time.now,
2153
+ # },
2154
+ # is_immutable: false,
2155
+ # rules: {
2156
+ # "RuleKey" => {
2157
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
2158
+ # parameters: {
2159
+ # "RuleParameterKey" => "RuleParameterValue",
2160
+ # },
2161
+ # },
2162
+ # },
2163
+ # },
2164
+ # attribute_reference: {
2165
+ # target_facet_name: "FacetName", # required
2166
+ # target_attribute_name: "AttributeName", # required
2167
+ # },
2168
+ # required_behavior: "REQUIRED_ALWAYS", # accepts REQUIRED_ALWAYS, NOT_REQUIRED
2169
+ # },
2170
+ # action: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
2171
+ # }
2172
+ #
2173
+ # @!attribute [rw] attribute
2174
+ # The attribute to update.
2175
+ # @return [Types::FacetAttribute]
2176
+ #
2177
+ # @!attribute [rw] action
2178
+ # The action to perform when updating the attribute.
2179
+ # @return [String]
2180
+ #
2181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeUpdate AWS API Documentation
2182
+ #
2183
+ class FacetAttributeUpdate < Struct.new(
2184
+ :attribute,
2185
+ :action)
2186
+ include Aws::Structure
2187
+ end
2188
+
2189
+ # @note When making an API call, you may pass GetDirectoryRequest
2190
+ # data as a hash:
2191
+ #
2192
+ # {
2193
+ # directory_arn: "DirectoryArn", # required
2194
+ # }
2195
+ #
2196
+ # @!attribute [rw] directory_arn
2197
+ # The ARN of the directory.
2198
+ # @return [String]
2199
+ #
2200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetDirectoryRequest AWS API Documentation
2201
+ #
2202
+ class GetDirectoryRequest < Struct.new(
2203
+ :directory_arn)
2204
+ include Aws::Structure
2205
+ end
2206
+
2207
+ # @!attribute [rw] directory
2208
+ # Metadata about the directory.
2209
+ # @return [Types::Directory]
2210
+ #
2211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetDirectoryResponse AWS API Documentation
2212
+ #
2213
+ class GetDirectoryResponse < Struct.new(
2214
+ :directory)
2215
+ include Aws::Structure
2216
+ end
2217
+
2218
+ # @note When making an API call, you may pass GetFacetRequest
2219
+ # data as a hash:
2220
+ #
2221
+ # {
2222
+ # schema_arn: "Arn", # required
2223
+ # name: "FacetName", # required
2224
+ # }
2225
+ #
2226
+ # @!attribute [rw] schema_arn
2227
+ # ARN associated with the Facet. For more information, see arns.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] name
2231
+ # The name of the facet to retrieve.
2232
+ # @return [String]
2233
+ #
2234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacetRequest AWS API Documentation
2235
+ #
2236
+ class GetFacetRequest < Struct.new(
2237
+ :schema_arn,
2238
+ :name)
2239
+ include Aws::Structure
2240
+ end
2241
+
2242
+ # @!attribute [rw] facet
2243
+ # Facet structure associated with the facet.
2244
+ # @return [Types::Facet]
2245
+ #
2246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacetResponse AWS API Documentation
2247
+ #
2248
+ class GetFacetResponse < Struct.new(
2249
+ :facet)
2250
+ include Aws::Structure
2251
+ end
2252
+
2253
+ # @note When making an API call, you may pass GetObjectInformationRequest
2254
+ # data as a hash:
2255
+ #
2256
+ # {
2257
+ # directory_arn: "Arn", # required
2258
+ # object_reference: { # required
2259
+ # selector: "SelectorObjectReference",
2260
+ # },
2261
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2262
+ # }
2263
+ #
2264
+ # @!attribute [rw] directory_arn
2265
+ # The ARN of the directory being retrieved.
2266
+ # @return [String]
2267
+ #
2268
+ # @!attribute [rw] object_reference
2269
+ # A reference to the object.
2270
+ # @return [Types::ObjectReference]
2271
+ #
2272
+ # @!attribute [rw] consistency_level
2273
+ # The consistency level at which to retrieve the object information.
2274
+ # @return [String]
2275
+ #
2276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetObjectInformationRequest AWS API Documentation
2277
+ #
2278
+ class GetObjectInformationRequest < Struct.new(
2279
+ :directory_arn,
2280
+ :object_reference,
2281
+ :consistency_level)
2282
+ include Aws::Structure
2283
+ end
2284
+
2285
+ # @!attribute [rw] schema_facets
2286
+ # The facets attached to the specified object.
2287
+ # @return [Array<Types::SchemaFacet>]
2288
+ #
2289
+ # @!attribute [rw] object_identifier
2290
+ # The ObjectIdentifier of the specified object.
2291
+ # @return [String]
2292
+ #
2293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetObjectInformationResponse AWS API Documentation
2294
+ #
2295
+ class GetObjectInformationResponse < Struct.new(
2296
+ :schema_facets,
2297
+ :object_identifier)
2298
+ include Aws::Structure
2299
+ end
2300
+
2301
+ # @note When making an API call, you may pass GetSchemaAsJsonRequest
2302
+ # data as a hash:
2303
+ #
2304
+ # {
2305
+ # schema_arn: "Arn", # required
2306
+ # }
2307
+ #
2308
+ # @!attribute [rw] schema_arn
2309
+ # The ARN of the schema to retrieve.
2310
+ # @return [String]
2311
+ #
2312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetSchemaAsJsonRequest AWS API Documentation
2313
+ #
2314
+ class GetSchemaAsJsonRequest < Struct.new(
2315
+ :schema_arn)
2316
+ include Aws::Structure
2317
+ end
2318
+
2319
+ # @!attribute [rw] name
2320
+ # The name of the retrieved schema.
2321
+ # @return [String]
2322
+ #
2323
+ # @!attribute [rw] document
2324
+ # The JSON representation of the schema document.
2325
+ # @return [String]
2326
+ #
2327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetSchemaAsJsonResponse AWS API Documentation
2328
+ #
2329
+ class GetSchemaAsJsonResponse < Struct.new(
2330
+ :name,
2331
+ :document)
2332
+ include Aws::Structure
2333
+ end
2334
+
2335
+ # Represents an index and an attached object.
2336
+ #
2337
+ # @!attribute [rw] indexed_attributes
2338
+ # The indexed attribute values.
2339
+ # @return [Array<Types::AttributeKeyAndValue>]
2340
+ #
2341
+ # @!attribute [rw] object_identifier
2342
+ # The ObjectIdentifier of the object attached to the index.
2343
+ # @return [String]
2344
+ #
2345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/IndexAttachment AWS API Documentation
2346
+ #
2347
+ class IndexAttachment < Struct.new(
2348
+ :indexed_attributes,
2349
+ :object_identifier)
2350
+ include Aws::Structure
2351
+ end
2352
+
2353
+ # @note When making an API call, you may pass ListAppliedSchemaArnsRequest
2354
+ # data as a hash:
2355
+ #
2356
+ # {
2357
+ # directory_arn: "Arn", # required
2358
+ # next_token: "NextToken",
2359
+ # max_results: 1,
2360
+ # }
2361
+ #
2362
+ # @!attribute [rw] directory_arn
2363
+ # The ARN of the directory you are listing.
2364
+ # @return [String]
2365
+ #
2366
+ # @!attribute [rw] next_token
2367
+ # The pagination token.
2368
+ # @return [String]
2369
+ #
2370
+ # @!attribute [rw] max_results
2371
+ # The maximum number of results to retrieve.
2372
+ # @return [Integer]
2373
+ #
2374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAppliedSchemaArnsRequest AWS API Documentation
2375
+ #
2376
+ class ListAppliedSchemaArnsRequest < Struct.new(
2377
+ :directory_arn,
2378
+ :next_token,
2379
+ :max_results)
2380
+ include Aws::Structure
2381
+ end
2382
+
2383
+ # @!attribute [rw] schema_arns
2384
+ # The ARNs of schemas that are applied to the directory.
2385
+ # @return [Array<String>]
2386
+ #
2387
+ # @!attribute [rw] next_token
2388
+ # The pagination token.
2389
+ # @return [String]
2390
+ #
2391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAppliedSchemaArnsResponse AWS API Documentation
2392
+ #
2393
+ class ListAppliedSchemaArnsResponse < Struct.new(
2394
+ :schema_arns,
2395
+ :next_token)
2396
+ include Aws::Structure
2397
+ end
2398
+
2399
+ # @note When making an API call, you may pass ListAttachedIndicesRequest
2400
+ # data as a hash:
2401
+ #
2402
+ # {
2403
+ # directory_arn: "Arn", # required
2404
+ # target_reference: { # required
2405
+ # selector: "SelectorObjectReference",
2406
+ # },
2407
+ # next_token: "NextToken",
2408
+ # max_results: 1,
2409
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2410
+ # }
2411
+ #
2412
+ # @!attribute [rw] directory_arn
2413
+ # The ARN of the directory.
2414
+ # @return [String]
2415
+ #
2416
+ # @!attribute [rw] target_reference
2417
+ # A reference to the object to that has indices attached.
2418
+ # @return [Types::ObjectReference]
2419
+ #
2420
+ # @!attribute [rw] next_token
2421
+ # The pagination token.
2422
+ # @return [String]
2423
+ #
2424
+ # @!attribute [rw] max_results
2425
+ # The maximum number of results to retrieve.
2426
+ # @return [Integer]
2427
+ #
2428
+ # @!attribute [rw] consistency_level
2429
+ # The consistency level to use for this operation.
2430
+ # @return [String]
2431
+ #
2432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAttachedIndicesRequest AWS API Documentation
2433
+ #
2434
+ class ListAttachedIndicesRequest < Struct.new(
2435
+ :directory_arn,
2436
+ :target_reference,
2437
+ :next_token,
2438
+ :max_results,
2439
+ :consistency_level)
2440
+ include Aws::Structure
2441
+ end
2442
+
2443
+ # @!attribute [rw] index_attachments
2444
+ # The indices attached to the specified object.
2445
+ # @return [Array<Types::IndexAttachment>]
2446
+ #
2447
+ # @!attribute [rw] next_token
2448
+ # The pagination token.
2449
+ # @return [String]
2450
+ #
2451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAttachedIndicesResponse AWS API Documentation
2452
+ #
2453
+ class ListAttachedIndicesResponse < Struct.new(
2454
+ :index_attachments,
2455
+ :next_token)
2456
+ include Aws::Structure
2457
+ end
2458
+
2459
+ # @note When making an API call, you may pass ListDevelopmentSchemaArnsRequest
2460
+ # data as a hash:
2461
+ #
2462
+ # {
2463
+ # next_token: "NextToken",
2464
+ # max_results: 1,
2465
+ # }
2466
+ #
2467
+ # @!attribute [rw] next_token
2468
+ # The pagination token.
2469
+ # @return [String]
2470
+ #
2471
+ # @!attribute [rw] max_results
2472
+ # The maximum number of results to retrieve.
2473
+ # @return [Integer]
2474
+ #
2475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDevelopmentSchemaArnsRequest AWS API Documentation
2476
+ #
2477
+ class ListDevelopmentSchemaArnsRequest < Struct.new(
2478
+ :next_token,
2479
+ :max_results)
2480
+ include Aws::Structure
2481
+ end
2482
+
2483
+ # @!attribute [rw] schema_arns
2484
+ # The ARNs of retrieved development schemas.
2485
+ # @return [Array<String>]
2486
+ #
2487
+ # @!attribute [rw] next_token
2488
+ # The pagination token.
2489
+ # @return [String]
2490
+ #
2491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDevelopmentSchemaArnsResponse AWS API Documentation
2492
+ #
2493
+ class ListDevelopmentSchemaArnsResponse < Struct.new(
2494
+ :schema_arns,
2495
+ :next_token)
2496
+ include Aws::Structure
2497
+ end
2498
+
2499
+ # @note When making an API call, you may pass ListDirectoriesRequest
2500
+ # data as a hash:
2501
+ #
2502
+ # {
2503
+ # next_token: "NextToken",
2504
+ # max_results: 1,
2505
+ # state: "ENABLED", # accepts ENABLED, DISABLED, DELETED
2506
+ # }
2507
+ #
2508
+ # @!attribute [rw] next_token
2509
+ # The pagination token.
2510
+ # @return [String]
2511
+ #
2512
+ # @!attribute [rw] max_results
2513
+ # The maximum number of results to retrieve.
2514
+ # @return [Integer]
2515
+ #
2516
+ # @!attribute [rw] state
2517
+ # The state of the directories in the list. Can be either Enabled,
2518
+ # Disabled, or Deleted.
2519
+ # @return [String]
2520
+ #
2521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDirectoriesRequest AWS API Documentation
2522
+ #
2523
+ class ListDirectoriesRequest < Struct.new(
2524
+ :next_token,
2525
+ :max_results,
2526
+ :state)
2527
+ include Aws::Structure
2528
+ end
2529
+
2530
+ # @!attribute [rw] directories
2531
+ # Lists all directories associated with your account in pagination
2532
+ # fashion.
2533
+ # @return [Array<Types::Directory>]
2534
+ #
2535
+ # @!attribute [rw] next_token
2536
+ # The pagination token.
2537
+ # @return [String]
2538
+ #
2539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDirectoriesResponse AWS API Documentation
2540
+ #
2541
+ class ListDirectoriesResponse < Struct.new(
2542
+ :directories,
2543
+ :next_token)
2544
+ include Aws::Structure
2545
+ end
2546
+
2547
+ # @note When making an API call, you may pass ListFacetAttributesRequest
2548
+ # data as a hash:
2549
+ #
2550
+ # {
2551
+ # schema_arn: "Arn", # required
2552
+ # name: "FacetName", # required
2553
+ # next_token: "NextToken",
2554
+ # max_results: 1,
2555
+ # }
2556
+ #
2557
+ # @!attribute [rw] schema_arn
2558
+ # The ARN of the schema where the facet resides.
2559
+ # @return [String]
2560
+ #
2561
+ # @!attribute [rw] name
2562
+ # The name of the facet whose attributes will be retrieved.
2563
+ # @return [String]
2564
+ #
2565
+ # @!attribute [rw] next_token
2566
+ # The pagination token.
2567
+ # @return [String]
2568
+ #
2569
+ # @!attribute [rw] max_results
2570
+ # The maximum number of results to retrieve.
2571
+ # @return [Integer]
2572
+ #
2573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetAttributesRequest AWS API Documentation
2574
+ #
2575
+ class ListFacetAttributesRequest < Struct.new(
2576
+ :schema_arn,
2577
+ :name,
2578
+ :next_token,
2579
+ :max_results)
2580
+ include Aws::Structure
2581
+ end
2582
+
2583
+ # @!attribute [rw] attributes
2584
+ # The attributes attached to the facet.
2585
+ # @return [Array<Types::FacetAttribute>]
2586
+ #
2587
+ # @!attribute [rw] next_token
2588
+ # The pagination token.
2589
+ # @return [String]
2590
+ #
2591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetAttributesResponse AWS API Documentation
2592
+ #
2593
+ class ListFacetAttributesResponse < Struct.new(
2594
+ :attributes,
2595
+ :next_token)
2596
+ include Aws::Structure
2597
+ end
2598
+
2599
+ # @note When making an API call, you may pass ListFacetNamesRequest
2600
+ # data as a hash:
2601
+ #
2602
+ # {
2603
+ # schema_arn: "Arn", # required
2604
+ # next_token: "NextToken",
2605
+ # max_results: 1,
2606
+ # }
2607
+ #
2608
+ # @!attribute [rw] schema_arn
2609
+ # The ARN to retrieve facet names from.
2610
+ # @return [String]
2611
+ #
2612
+ # @!attribute [rw] next_token
2613
+ # The pagination token.
2614
+ # @return [String]
2615
+ #
2616
+ # @!attribute [rw] max_results
2617
+ # The maximum number of results to retrieve
2618
+ # @return [Integer]
2619
+ #
2620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNamesRequest AWS API Documentation
2621
+ #
2622
+ class ListFacetNamesRequest < Struct.new(
2623
+ :schema_arn,
2624
+ :next_token,
2625
+ :max_results)
2626
+ include Aws::Structure
2627
+ end
2628
+
2629
+ # @!attribute [rw] facet_names
2630
+ # The names of facets that exist within the schema.
2631
+ # @return [Array<String>]
2632
+ #
2633
+ # @!attribute [rw] next_token
2634
+ # The pagination token.
2635
+ # @return [String]
2636
+ #
2637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNamesResponse AWS API Documentation
2638
+ #
2639
+ class ListFacetNamesResponse < Struct.new(
2640
+ :facet_names,
2641
+ :next_token)
2642
+ include Aws::Structure
2643
+ end
2644
+
2645
+ # @note When making an API call, you may pass ListIndexRequest
2646
+ # data as a hash:
2647
+ #
2648
+ # {
2649
+ # directory_arn: "Arn", # required
2650
+ # ranges_on_indexed_values: [
2651
+ # {
2652
+ # attribute_key: {
2653
+ # schema_arn: "Arn", # required
2654
+ # facet_name: "FacetName", # required
2655
+ # name: "AttributeName", # required
2656
+ # },
2657
+ # range: {
2658
+ # start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
2659
+ # start_value: {
2660
+ # string_value: "StringAttributeValue",
2661
+ # binary_value: "data",
2662
+ # boolean_value: false,
2663
+ # number_value: "NumberAttributeValue",
2664
+ # datetime_value: Time.now,
2665
+ # },
2666
+ # end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
2667
+ # end_value: {
2668
+ # string_value: "StringAttributeValue",
2669
+ # binary_value: "data",
2670
+ # boolean_value: false,
2671
+ # number_value: "NumberAttributeValue",
2672
+ # datetime_value: Time.now,
2673
+ # },
2674
+ # },
2675
+ # },
2676
+ # ],
2677
+ # index_reference: { # required
2678
+ # selector: "SelectorObjectReference",
2679
+ # },
2680
+ # max_results: 1,
2681
+ # next_token: "NextToken",
2682
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2683
+ # }
2684
+ #
2685
+ # @!attribute [rw] directory_arn
2686
+ # The ARN of the directory that the index exists in.
2687
+ # @return [String]
2688
+ #
2689
+ # @!attribute [rw] ranges_on_indexed_values
2690
+ # Specifies the ranges of indexed values that you want to query.
2691
+ # @return [Array<Types::ObjectAttributeRange>]
2692
+ #
2693
+ # @!attribute [rw] index_reference
2694
+ # The reference to the index to list.
2695
+ # @return [Types::ObjectReference]
2696
+ #
2697
+ # @!attribute [rw] max_results
2698
+ # The maximum number of results to retrieve from the index.
2699
+ # @return [Integer]
2700
+ #
2701
+ # @!attribute [rw] next_token
2702
+ # The pagination token.
2703
+ # @return [String]
2704
+ #
2705
+ # @!attribute [rw] consistency_level
2706
+ # The consistency level to execute the request at.
2707
+ # @return [String]
2708
+ #
2709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIndexRequest AWS API Documentation
2710
+ #
2711
+ class ListIndexRequest < Struct.new(
2712
+ :directory_arn,
2713
+ :ranges_on_indexed_values,
2714
+ :index_reference,
2715
+ :max_results,
2716
+ :next_token,
2717
+ :consistency_level)
2718
+ include Aws::Structure
2719
+ end
2720
+
2721
+ # @!attribute [rw] index_attachments
2722
+ # The objects and indexed values attached to the index.
2723
+ # @return [Array<Types::IndexAttachment>]
2724
+ #
2725
+ # @!attribute [rw] next_token
2726
+ # The pagination token.
2727
+ # @return [String]
2728
+ #
2729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIndexResponse AWS API Documentation
2730
+ #
2731
+ class ListIndexResponse < Struct.new(
2732
+ :index_attachments,
2733
+ :next_token)
2734
+ include Aws::Structure
2735
+ end
2736
+
2737
+ # @note When making an API call, you may pass ListObjectAttributesRequest
2738
+ # data as a hash:
2739
+ #
2740
+ # {
2741
+ # directory_arn: "Arn", # required
2742
+ # object_reference: { # required
2743
+ # selector: "SelectorObjectReference",
2744
+ # },
2745
+ # next_token: "NextToken",
2746
+ # max_results: 1,
2747
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2748
+ # }
2749
+ #
2750
+ # @!attribute [rw] directory_arn
2751
+ # ARN associated with the Directory where the object resides. For more
2752
+ # information, see arns.
2753
+ # @return [String]
2754
+ #
2755
+ # @!attribute [rw] object_reference
2756
+ # Reference that identifies the object whose attributes will be
2757
+ # listed.
2758
+ # @return [Types::ObjectReference]
2759
+ #
2760
+ # @!attribute [rw] next_token
2761
+ # Token used for pagination.
2762
+ # @return [String]
2763
+ #
2764
+ # @!attribute [rw] max_results
2765
+ # Maximum number of items to be retrieved in a single call. This is an
2766
+ # approximate number.
2767
+ # @return [Integer]
2768
+ #
2769
+ # @!attribute [rw] consistency_level
2770
+ # Represents the manner and timing in which the successful write or
2771
+ # update of an object is reflected in a subsequent read operation of
2772
+ # that same object.
2773
+ # @return [String]
2774
+ #
2775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributesRequest AWS API Documentation
2776
+ #
2777
+ class ListObjectAttributesRequest < Struct.new(
2778
+ :directory_arn,
2779
+ :object_reference,
2780
+ :next_token,
2781
+ :max_results,
2782
+ :consistency_level)
2783
+ include Aws::Structure
2784
+ end
2785
+
2786
+ # @!attribute [rw] attributes
2787
+ # Attributes map associated with the object. AttributeArn is the key,
2788
+ # and attribute value is the value.
2789
+ # @return [Array<Types::AttributeKeyAndValue>]
2790
+ #
2791
+ # @!attribute [rw] next_token
2792
+ # Token used for pagination.
2793
+ # @return [String]
2794
+ #
2795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributesResponse AWS API Documentation
2796
+ #
2797
+ class ListObjectAttributesResponse < Struct.new(
2798
+ :attributes,
2799
+ :next_token)
2800
+ include Aws::Structure
2801
+ end
2802
+
2803
+ # @note When making an API call, you may pass ListObjectChildrenRequest
2804
+ # data as a hash:
2805
+ #
2806
+ # {
2807
+ # directory_arn: "Arn", # required
2808
+ # object_reference: { # required
2809
+ # selector: "SelectorObjectReference",
2810
+ # },
2811
+ # next_token: "NextToken",
2812
+ # max_results: 1,
2813
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2814
+ # }
2815
+ #
2816
+ # @!attribute [rw] directory_arn
2817
+ # ARN associated with the Directory where the object resides. For more
2818
+ # information, see arns.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] object_reference
2822
+ # Reference that identifies the object for which child objects are
2823
+ # being listed.
2824
+ # @return [Types::ObjectReference]
2825
+ #
2826
+ # @!attribute [rw] next_token
2827
+ # Token used for pagination.
2828
+ # @return [String]
2829
+ #
2830
+ # @!attribute [rw] max_results
2831
+ # Maximum number of items to be retrieved in a single call. This is an
2832
+ # approximate number.
2833
+ # @return [Integer]
2834
+ #
2835
+ # @!attribute [rw] consistency_level
2836
+ # Represents the manner and timing in which the successful write or
2837
+ # update of an object is reflected in a subsequent read operation of
2838
+ # that same object.
2839
+ # @return [String]
2840
+ #
2841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectChildrenRequest AWS API Documentation
2842
+ #
2843
+ class ListObjectChildrenRequest < Struct.new(
2844
+ :directory_arn,
2845
+ :object_reference,
2846
+ :next_token,
2847
+ :max_results,
2848
+ :consistency_level)
2849
+ include Aws::Structure
2850
+ end
2851
+
2852
+ # @!attribute [rw] children
2853
+ # Children structure, which is a map with key as the LinkName and
2854
+ # ObjectIdentifier as the value.
2855
+ # @return [Hash<String,String>]
2856
+ #
2857
+ # @!attribute [rw] next_token
2858
+ # Token used for pagination.
2859
+ # @return [String]
2860
+ #
2861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectChildrenResponse AWS API Documentation
2862
+ #
2863
+ class ListObjectChildrenResponse < Struct.new(
2864
+ :children,
2865
+ :next_token)
2866
+ include Aws::Structure
2867
+ end
2868
+
2869
+ # @note When making an API call, you may pass ListObjectParentsRequest
2870
+ # data as a hash:
2871
+ #
2872
+ # {
2873
+ # directory_arn: "Arn", # required
2874
+ # object_reference: { # required
2875
+ # selector: "SelectorObjectReference",
2876
+ # },
2877
+ # next_token: "NextToken",
2878
+ # max_results: 1,
2879
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2880
+ # }
2881
+ #
2882
+ # @!attribute [rw] directory_arn
2883
+ # ARN associated with the Directory where the object resides. For more
2884
+ # information, see arns.
2885
+ # @return [String]
2886
+ #
2887
+ # @!attribute [rw] object_reference
2888
+ # Reference that identifies the object for which parent objects are
2889
+ # being listed.
2890
+ # @return [Types::ObjectReference]
2891
+ #
2892
+ # @!attribute [rw] next_token
2893
+ # Token used for pagination.
2894
+ # @return [String]
2895
+ #
2896
+ # @!attribute [rw] max_results
2897
+ # Maximum number of items to be retrieved in a single call. This is an
2898
+ # approximate number.
2899
+ # @return [Integer]
2900
+ #
2901
+ # @!attribute [rw] consistency_level
2902
+ # Represents the manner and timing in which the successful write or
2903
+ # update of an object is reflected in a subsequent read operation of
2904
+ # that same object.
2905
+ # @return [String]
2906
+ #
2907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentsRequest AWS API Documentation
2908
+ #
2909
+ class ListObjectParentsRequest < Struct.new(
2910
+ :directory_arn,
2911
+ :object_reference,
2912
+ :next_token,
2913
+ :max_results,
2914
+ :consistency_level)
2915
+ include Aws::Structure
2916
+ end
2917
+
2918
+ # @!attribute [rw] parents
2919
+ # Parent structure, which is a map with key as the ObjectIdentifier
2920
+ # and LinkName as the value.
2921
+ # @return [Hash<String,String>]
2922
+ #
2923
+ # @!attribute [rw] next_token
2924
+ # Token used for pagination.
2925
+ # @return [String]
2926
+ #
2927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentsResponse AWS API Documentation
2928
+ #
2929
+ class ListObjectParentsResponse < Struct.new(
2930
+ :parents,
2931
+ :next_token)
2932
+ include Aws::Structure
2933
+ end
2934
+
2935
+ # @note When making an API call, you may pass ListObjectPoliciesRequest
2936
+ # data as a hash:
2937
+ #
2938
+ # {
2939
+ # directory_arn: "Arn", # required
2940
+ # object_reference: { # required
2941
+ # selector: "SelectorObjectReference",
2942
+ # },
2943
+ # next_token: "NextToken",
2944
+ # max_results: 1,
2945
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
2946
+ # }
2947
+ #
2948
+ # @!attribute [rw] directory_arn
2949
+ # ARN associated with the Directory where objects reside. For more
2950
+ # information, see arns.
2951
+ # @return [String]
2952
+ #
2953
+ # @!attribute [rw] object_reference
2954
+ # Reference that identifies the object for which policies will be
2955
+ # listed.
2956
+ # @return [Types::ObjectReference]
2957
+ #
2958
+ # @!attribute [rw] next_token
2959
+ # Token used for pagination.
2960
+ # @return [String]
2961
+ #
2962
+ # @!attribute [rw] max_results
2963
+ # Maximum number of items to be retrieved in a single call. This is an
2964
+ # approximate number.
2965
+ # @return [Integer]
2966
+ #
2967
+ # @!attribute [rw] consistency_level
2968
+ # Represents the manner and timing in which the successful write or
2969
+ # update of an object is reflected in a subsequent read operation of
2970
+ # that same object.
2971
+ # @return [String]
2972
+ #
2973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectPoliciesRequest AWS API Documentation
2974
+ #
2975
+ class ListObjectPoliciesRequest < Struct.new(
2976
+ :directory_arn,
2977
+ :object_reference,
2978
+ :next_token,
2979
+ :max_results,
2980
+ :consistency_level)
2981
+ include Aws::Structure
2982
+ end
2983
+
2984
+ # @!attribute [rw] attached_policy_ids
2985
+ # List of policy ObjectIdentifiers, that are attached to the object.
2986
+ # @return [Array<String>]
2987
+ #
2988
+ # @!attribute [rw] next_token
2989
+ # Token used for pagination.
2990
+ # @return [String]
2991
+ #
2992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectPoliciesResponse AWS API Documentation
2993
+ #
2994
+ class ListObjectPoliciesResponse < Struct.new(
2995
+ :attached_policy_ids,
2996
+ :next_token)
2997
+ include Aws::Structure
2998
+ end
2999
+
3000
+ # @note When making an API call, you may pass ListPolicyAttachmentsRequest
3001
+ # data as a hash:
3002
+ #
3003
+ # {
3004
+ # directory_arn: "Arn", # required
3005
+ # policy_reference: { # required
3006
+ # selector: "SelectorObjectReference",
3007
+ # },
3008
+ # next_token: "NextToken",
3009
+ # max_results: 1,
3010
+ # consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
3011
+ # }
3012
+ #
3013
+ # @!attribute [rw] directory_arn
3014
+ # ARN associated with the Directory where objects reside. For more
3015
+ # information, see arns.
3016
+ # @return [String]
3017
+ #
3018
+ # @!attribute [rw] policy_reference
3019
+ # Reference that identifies the policy object.
3020
+ # @return [Types::ObjectReference]
3021
+ #
3022
+ # @!attribute [rw] next_token
3023
+ # Token used for pagination.
3024
+ # @return [String]
3025
+ #
3026
+ # @!attribute [rw] max_results
3027
+ # Maximum number of items to be retrieved in a single call. This is an
3028
+ # approximate number.
3029
+ # @return [Integer]
3030
+ #
3031
+ # @!attribute [rw] consistency_level
3032
+ # Represents the manner and timing in which the successful write or
3033
+ # update of an object is reflected in a subsequent read operation of
3034
+ # that same object.
3035
+ # @return [String]
3036
+ #
3037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPolicyAttachmentsRequest AWS API Documentation
3038
+ #
3039
+ class ListPolicyAttachmentsRequest < Struct.new(
3040
+ :directory_arn,
3041
+ :policy_reference,
3042
+ :next_token,
3043
+ :max_results,
3044
+ :consistency_level)
3045
+ include Aws::Structure
3046
+ end
3047
+
3048
+ # @!attribute [rw] object_identifiers
3049
+ # List of ObjectIdentifiers to which the policy is attached.
3050
+ # @return [Array<String>]
3051
+ #
3052
+ # @!attribute [rw] next_token
3053
+ # Token used for pagination.
3054
+ # @return [String]
3055
+ #
3056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPolicyAttachmentsResponse AWS API Documentation
3057
+ #
3058
+ class ListPolicyAttachmentsResponse < Struct.new(
3059
+ :object_identifiers,
3060
+ :next_token)
3061
+ include Aws::Structure
3062
+ end
3063
+
3064
+ # @note When making an API call, you may pass ListPublishedSchemaArnsRequest
3065
+ # data as a hash:
3066
+ #
3067
+ # {
3068
+ # next_token: "NextToken",
3069
+ # max_results: 1,
3070
+ # }
3071
+ #
3072
+ # @!attribute [rw] next_token
3073
+ # The pagination token.
3074
+ # @return [String]
3075
+ #
3076
+ # @!attribute [rw] max_results
3077
+ # The maximum number of results to retrieve.
3078
+ # @return [Integer]
3079
+ #
3080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPublishedSchemaArnsRequest AWS API Documentation
3081
+ #
3082
+ class ListPublishedSchemaArnsRequest < Struct.new(
3083
+ :next_token,
3084
+ :max_results)
3085
+ include Aws::Structure
3086
+ end
3087
+
3088
+ # @!attribute [rw] schema_arns
3089
+ # The ARNs of published schemas.
3090
+ # @return [Array<String>]
3091
+ #
3092
+ # @!attribute [rw] next_token
3093
+ # The pagination token.
3094
+ # @return [String]
3095
+ #
3096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPublishedSchemaArnsResponse AWS API Documentation
3097
+ #
3098
+ class ListPublishedSchemaArnsResponse < Struct.new(
3099
+ :schema_arns,
3100
+ :next_token)
3101
+ include Aws::Structure
3102
+ end
3103
+
3104
+ # @note When making an API call, you may pass ListTagsForResourceRequest
3105
+ # data as a hash:
3106
+ #
3107
+ # {
3108
+ # resource_arn: "Arn", # required
3109
+ # next_token: "NextToken",
3110
+ # max_results: 1,
3111
+ # }
3112
+ #
3113
+ # @!attribute [rw] resource_arn
3114
+ # ARN of the resource. Tagging is only supported for directories.
3115
+ # @return [String]
3116
+ #
3117
+ # @!attribute [rw] next_token
3118
+ # Next token used for pagination. This is for future use. Currently
3119
+ # pagination is not supported for tagging.
3120
+ # @return [String]
3121
+ #
3122
+ # @!attribute [rw] max_results
3123
+ # The MaxResults parameter sets the maximum number of results returned
3124
+ # in a single page. This is for future use and is not supported
3125
+ # currently.
3126
+ # @return [Integer]
3127
+ #
3128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResourceRequest AWS API Documentation
3129
+ #
3130
+ class ListTagsForResourceRequest < Struct.new(
3131
+ :resource_arn,
3132
+ :next_token,
3133
+ :max_results)
3134
+ include Aws::Structure
3135
+ end
3136
+
3137
+ # @!attribute [rw] tags
3138
+ # List of tag key value pairs associated with the response.
3139
+ # @return [Array<Types::Tag>]
3140
+ #
3141
+ # @!attribute [rw] next_token
3142
+ # The token to use to retrieve the next page of results. This value is
3143
+ # null when there are no more results to return.
3144
+ # @return [String]
3145
+ #
3146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResourceResponse AWS API Documentation
3147
+ #
3148
+ class ListTagsForResourceResponse < Struct.new(
3149
+ :tags,
3150
+ :next_token)
3151
+ include Aws::Structure
3152
+ end
3153
+
3154
+ # @note When making an API call, you may pass LookupPolicyRequest
3155
+ # data as a hash:
3156
+ #
3157
+ # {
3158
+ # directory_arn: "Arn", # required
3159
+ # object_reference: { # required
3160
+ # selector: "SelectorObjectReference",
3161
+ # },
3162
+ # next_token: "NextToken",
3163
+ # max_results: 1,
3164
+ # }
3165
+ #
3166
+ # @!attribute [rw] directory_arn
3167
+ # ARN associated with the Directory. For more information, see arns.
3168
+ # @return [String]
3169
+ #
3170
+ # @!attribute [rw] object_reference
3171
+ # Reference that identifies the object whose policies will be looked
3172
+ # up.
3173
+ # @return [Types::ObjectReference]
3174
+ #
3175
+ # @!attribute [rw] next_token
3176
+ # The token to request the next page of results.
3177
+ # @return [String]
3178
+ #
3179
+ # @!attribute [rw] max_results
3180
+ # Maximum number of items to be retrieved in a single call. This is an
3181
+ # approximate number.
3182
+ # @return [Integer]
3183
+ #
3184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyRequest AWS API Documentation
3185
+ #
3186
+ class LookupPolicyRequest < Struct.new(
3187
+ :directory_arn,
3188
+ :object_reference,
3189
+ :next_token,
3190
+ :max_results)
3191
+ include Aws::Structure
3192
+ end
3193
+
3194
+ # @!attribute [rw] policy_to_path_list
3195
+ # Provides list of path to policies. Policies contain PolicyId,
3196
+ # ObjectIdentifier, and PolicyType.
3197
+ # @return [Array<Types::PolicyToPath>]
3198
+ #
3199
+ # @!attribute [rw] next_token
3200
+ # Token used for pagination.
3201
+ # @return [String]
3202
+ #
3203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyResponse AWS API Documentation
3204
+ #
3205
+ class LookupPolicyResponse < Struct.new(
3206
+ :policy_to_path_list,
3207
+ :next_token)
3208
+ include Aws::Structure
3209
+ end
3210
+
3211
+ # The action to take on the object attribute.
3212
+ #
3213
+ # @note When making an API call, you may pass ObjectAttributeAction
3214
+ # data as a hash:
3215
+ #
3216
+ # {
3217
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
3218
+ # object_attribute_update_value: {
3219
+ # string_value: "StringAttributeValue",
3220
+ # binary_value: "data",
3221
+ # boolean_value: false,
3222
+ # number_value: "NumberAttributeValue",
3223
+ # datetime_value: Time.now,
3224
+ # },
3225
+ # }
3226
+ #
3227
+ # @!attribute [rw] object_attribute_action_type
3228
+ # Type can be either Update or Delete.
3229
+ # @return [String]
3230
+ #
3231
+ # @!attribute [rw] object_attribute_update_value
3232
+ # The value that you want to update to.
3233
+ # @return [Types::TypedAttributeValue]
3234
+ #
3235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeAction AWS API Documentation
3236
+ #
3237
+ class ObjectAttributeAction < Struct.new(
3238
+ :object_attribute_action_type,
3239
+ :object_attribute_update_value)
3240
+ include Aws::Structure
3241
+ end
3242
+
3243
+ # A range of attributes.
3244
+ #
3245
+ # @note When making an API call, you may pass ObjectAttributeRange
3246
+ # data as a hash:
3247
+ #
3248
+ # {
3249
+ # attribute_key: {
3250
+ # schema_arn: "Arn", # required
3251
+ # facet_name: "FacetName", # required
3252
+ # name: "AttributeName", # required
3253
+ # },
3254
+ # range: {
3255
+ # start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
3256
+ # start_value: {
3257
+ # string_value: "StringAttributeValue",
3258
+ # binary_value: "data",
3259
+ # boolean_value: false,
3260
+ # number_value: "NumberAttributeValue",
3261
+ # datetime_value: Time.now,
3262
+ # },
3263
+ # end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
3264
+ # end_value: {
3265
+ # string_value: "StringAttributeValue",
3266
+ # binary_value: "data",
3267
+ # boolean_value: false,
3268
+ # number_value: "NumberAttributeValue",
3269
+ # datetime_value: Time.now,
3270
+ # },
3271
+ # },
3272
+ # }
3273
+ #
3274
+ # @!attribute [rw] attribute_key
3275
+ # The key of the attribute the attribute range covers.
3276
+ # @return [Types::AttributeKey]
3277
+ #
3278
+ # @!attribute [rw] range
3279
+ # The range of attribute values being selected.
3280
+ # @return [Types::TypedAttributeValueRange]
3281
+ #
3282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeRange AWS API Documentation
3283
+ #
3284
+ class ObjectAttributeRange < Struct.new(
3285
+ :attribute_key,
3286
+ :range)
3287
+ include Aws::Structure
3288
+ end
3289
+
3290
+ # Structure that contains attribute update information.
3291
+ #
3292
+ # @note When making an API call, you may pass ObjectAttributeUpdate
3293
+ # data as a hash:
3294
+ #
3295
+ # {
3296
+ # object_attribute_key: {
3297
+ # schema_arn: "Arn", # required
3298
+ # facet_name: "FacetName", # required
3299
+ # name: "AttributeName", # required
3300
+ # },
3301
+ # object_attribute_action: {
3302
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
3303
+ # object_attribute_update_value: {
3304
+ # string_value: "StringAttributeValue",
3305
+ # binary_value: "data",
3306
+ # boolean_value: false,
3307
+ # number_value: "NumberAttributeValue",
3308
+ # datetime_value: Time.now,
3309
+ # },
3310
+ # },
3311
+ # }
3312
+ #
3313
+ # @!attribute [rw] object_attribute_key
3314
+ # The key of the attribute being updated.
3315
+ # @return [Types::AttributeKey]
3316
+ #
3317
+ # @!attribute [rw] object_attribute_action
3318
+ # The action to perform as part of the attribute update.
3319
+ # @return [Types::ObjectAttributeAction]
3320
+ #
3321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeUpdate AWS API Documentation
3322
+ #
3323
+ class ObjectAttributeUpdate < Struct.new(
3324
+ :object_attribute_key,
3325
+ :object_attribute_action)
3326
+ include Aws::Structure
3327
+ end
3328
+
3329
+ # Reference that identifies an object.
3330
+ #
3331
+ # @note When making an API call, you may pass ObjectReference
3332
+ # data as a hash:
3333
+ #
3334
+ # {
3335
+ # selector: "SelectorObjectReference",
3336
+ # }
3337
+ #
3338
+ # @!attribute [rw] selector
3339
+ # Allows you to specify an object. You can identify an object in one
3340
+ # of the following ways:
3341
+ #
3342
+ # * *$ObjectIdentifier* - Identifies the object by ObjectIdentifier
3343
+ #
3344
+ # * */some/path* - Identifies the object based on path
3345
+ #
3346
+ # * *#SomeBatchReference* - Identifies the object in a batch call
3347
+ # @return [String]
3348
+ #
3349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectReference AWS API Documentation
3350
+ #
3351
+ class ObjectReference < Struct.new(
3352
+ :selector)
3353
+ include Aws::Structure
3354
+ end
3355
+
3356
+ # Contains the PolicyType, PolicyId, and the ObjectIdentifier to which
3357
+ # it is attached.
3358
+ #
3359
+ # @!attribute [rw] policy_id
3360
+ # The ID of PolicyAttachment.
3361
+ # @return [String]
3362
+ #
3363
+ # @!attribute [rw] object_identifier
3364
+ # The ObjectIdentifier associated with PolicyAttachment.
3365
+ # @return [String]
3366
+ #
3367
+ # @!attribute [rw] policy_type
3368
+ # The type of policy that can be associated with PolicyAttachment.
3369
+ # @return [String]
3370
+ #
3371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PolicyAttachment AWS API Documentation
3372
+ #
3373
+ class PolicyAttachment < Struct.new(
3374
+ :policy_id,
3375
+ :object_identifier,
3376
+ :policy_type)
3377
+ include Aws::Structure
3378
+ end
3379
+
3380
+ # Used when a regular object exists in a Directory and you want to find
3381
+ # all of the policies associated with that object and the parent to that
3382
+ # object.
3383
+ #
3384
+ # @!attribute [rw] path
3385
+ # The path that is referenced from the root.
3386
+ # @return [String]
3387
+ #
3388
+ # @!attribute [rw] policies
3389
+ # List of policy objects.
3390
+ # @return [Array<Types::PolicyAttachment>]
3391
+ #
3392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PolicyToPath AWS API Documentation
3393
+ #
3394
+ class PolicyToPath < Struct.new(
3395
+ :path,
3396
+ :policies)
3397
+ include Aws::Structure
3398
+ end
3399
+
3400
+ # @note When making an API call, you may pass PublishSchemaRequest
3401
+ # data as a hash:
3402
+ #
3403
+ # {
3404
+ # development_schema_arn: "Arn", # required
3405
+ # version: "Version", # required
3406
+ # name: "SchemaName",
3407
+ # }
3408
+ #
3409
+ # @!attribute [rw] development_schema_arn
3410
+ # ARN associated with the development schema. For more information,
3411
+ # see arns.
3412
+ # @return [String]
3413
+ #
3414
+ # @!attribute [rw] version
3415
+ # Version under which the schema will be published.
3416
+ # @return [String]
3417
+ #
3418
+ # @!attribute [rw] name
3419
+ # New name under which the schema will be published. If this is not
3420
+ # provided, the development schema is considered.
3421
+ # @return [String]
3422
+ #
3423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaRequest AWS API Documentation
3424
+ #
3425
+ class PublishSchemaRequest < Struct.new(
3426
+ :development_schema_arn,
3427
+ :version,
3428
+ :name)
3429
+ include Aws::Structure
3430
+ end
3431
+
3432
+ # @!attribute [rw] published_schema_arn
3433
+ # ARN associated with the published schema. For more information, see
3434
+ # arns.
3435
+ # @return [String]
3436
+ #
3437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaResponse AWS API Documentation
3438
+ #
3439
+ class PublishSchemaResponse < Struct.new(
3440
+ :published_schema_arn)
3441
+ include Aws::Structure
3442
+ end
3443
+
3444
+ # @note When making an API call, you may pass PutSchemaFromJsonRequest
3445
+ # data as a hash:
3446
+ #
3447
+ # {
3448
+ # schema_arn: "Arn", # required
3449
+ # document: "SchemaJsonDocument", # required
3450
+ # }
3451
+ #
3452
+ # @!attribute [rw] schema_arn
3453
+ # The ARN of the schema to update.
3454
+ # @return [String]
3455
+ #
3456
+ # @!attribute [rw] document
3457
+ # The replacement JSON schema.
3458
+ # @return [String]
3459
+ #
3460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PutSchemaFromJsonRequest AWS API Documentation
3461
+ #
3462
+ class PutSchemaFromJsonRequest < Struct.new(
3463
+ :schema_arn,
3464
+ :document)
3465
+ include Aws::Structure
3466
+ end
3467
+
3468
+ # @!attribute [rw] arn
3469
+ # The ARN of the schema to update.
3470
+ # @return [String]
3471
+ #
3472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PutSchemaFromJsonResponse AWS API Documentation
3473
+ #
3474
+ class PutSchemaFromJsonResponse < Struct.new(
3475
+ :arn)
3476
+ include Aws::Structure
3477
+ end
3478
+
3479
+ # @note When making an API call, you may pass RemoveFacetFromObjectRequest
3480
+ # data as a hash:
3481
+ #
3482
+ # {
3483
+ # directory_arn: "Arn", # required
3484
+ # schema_facet: { # required
3485
+ # schema_arn: "Arn",
3486
+ # facet_name: "FacetName",
3487
+ # },
3488
+ # object_reference: { # required
3489
+ # selector: "SelectorObjectReference",
3490
+ # },
3491
+ # }
3492
+ #
3493
+ # @!attribute [rw] directory_arn
3494
+ # The ARN of the directory in which the object resides.
3495
+ # @return [String]
3496
+ #
3497
+ # @!attribute [rw] schema_facet
3498
+ # The facet to remove.
3499
+ # @return [Types::SchemaFacet]
3500
+ #
3501
+ # @!attribute [rw] object_reference
3502
+ # A reference to the object to remove the facet from.
3503
+ # @return [Types::ObjectReference]
3504
+ #
3505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/RemoveFacetFromObjectRequest AWS API Documentation
3506
+ #
3507
+ class RemoveFacetFromObjectRequest < Struct.new(
3508
+ :directory_arn,
3509
+ :schema_facet,
3510
+ :object_reference)
3511
+ include Aws::Structure
3512
+ end
3513
+
3514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/RemoveFacetFromObjectResponse AWS API Documentation
3515
+ #
3516
+ class RemoveFacetFromObjectResponse < Aws::EmptyStructure; end
3517
+
3518
+ # Contains an ARN and parameters associated with the rule.
3519
+ #
3520
+ # @note When making an API call, you may pass Rule
3521
+ # data as a hash:
3522
+ #
3523
+ # {
3524
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
3525
+ # parameters: {
3526
+ # "RuleParameterKey" => "RuleParameterValue",
3527
+ # },
3528
+ # }
3529
+ #
3530
+ # @!attribute [rw] type
3531
+ # The type of attribute validation rule.
3532
+ # @return [String]
3533
+ #
3534
+ # @!attribute [rw] parameters
3535
+ # Min and max parameters associated with the rule.
3536
+ # @return [Hash<String,String>]
3537
+ #
3538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Rule AWS API Documentation
3539
+ #
3540
+ class Rule < Struct.new(
3541
+ :type,
3542
+ :parameters)
3543
+ include Aws::Structure
3544
+ end
3545
+
3546
+ # A facet.
3547
+ #
3548
+ # @note When making an API call, you may pass SchemaFacet
3549
+ # data as a hash:
3550
+ #
3551
+ # {
3552
+ # schema_arn: "Arn",
3553
+ # facet_name: "FacetName",
3554
+ # }
3555
+ #
3556
+ # @!attribute [rw] schema_arn
3557
+ # The ARN of the schema that contains the facet.
3558
+ # @return [String]
3559
+ #
3560
+ # @!attribute [rw] facet_name
3561
+ # The name of the facet.
3562
+ # @return [String]
3563
+ #
3564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/SchemaFacet AWS API Documentation
3565
+ #
3566
+ class SchemaFacet < Struct.new(
3567
+ :schema_arn,
3568
+ :facet_name)
3569
+ include Aws::Structure
3570
+ end
3571
+
3572
+ # Tag structure which contains tag key and value.
3573
+ #
3574
+ # @note When making an API call, you may pass Tag
3575
+ # data as a hash:
3576
+ #
3577
+ # {
3578
+ # key: "TagKey",
3579
+ # value: "TagValue",
3580
+ # }
3581
+ #
3582
+ # @!attribute [rw] key
3583
+ # Key associated with the tag.
3584
+ # @return [String]
3585
+ #
3586
+ # @!attribute [rw] value
3587
+ # Value associated with the tag.
3588
+ # @return [String]
3589
+ #
3590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Tag AWS API Documentation
3591
+ #
3592
+ class Tag < Struct.new(
3593
+ :key,
3594
+ :value)
3595
+ include Aws::Structure
3596
+ end
3597
+
3598
+ # @note When making an API call, you may pass TagResourceRequest
3599
+ # data as a hash:
3600
+ #
3601
+ # {
3602
+ # resource_arn: "Arn", # required
3603
+ # tags: [ # required
3604
+ # {
3605
+ # key: "TagKey",
3606
+ # value: "TagValue",
3607
+ # },
3608
+ # ],
3609
+ # }
3610
+ #
3611
+ # @!attribute [rw] resource_arn
3612
+ # ARN of the resource. Tagging is only supported for directories.
3613
+ # @return [String]
3614
+ #
3615
+ # @!attribute [rw] tags
3616
+ # List of tag key value pairs.
3617
+ # @return [Array<Types::Tag>]
3618
+ #
3619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResourceRequest AWS API Documentation
3620
+ #
3621
+ class TagResourceRequest < Struct.new(
3622
+ :resource_arn,
3623
+ :tags)
3624
+ include Aws::Structure
3625
+ end
3626
+
3627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResourceResponse AWS API Documentation
3628
+ #
3629
+ class TagResourceResponse < Aws::EmptyStructure; end
3630
+
3631
+ # Represents the data for a typed attribute. You can set one, and only
3632
+ # one, of the elements. Each attribute in an item is a name-value pair.
3633
+ # Attributes have a single value.
3634
+ #
3635
+ # @note When making an API call, you may pass TypedAttributeValue
3636
+ # data as a hash:
3637
+ #
3638
+ # {
3639
+ # string_value: "StringAttributeValue",
3640
+ # binary_value: "data",
3641
+ # boolean_value: false,
3642
+ # number_value: "NumberAttributeValue",
3643
+ # datetime_value: Time.now,
3644
+ # }
3645
+ #
3646
+ # @!attribute [rw] string_value
3647
+ # A string data value.
3648
+ # @return [String]
3649
+ #
3650
+ # @!attribute [rw] binary_value
3651
+ # A binary data value.
3652
+ # @return [String]
3653
+ #
3654
+ # @!attribute [rw] boolean_value
3655
+ # A Boolean data value.
3656
+ # @return [Boolean]
3657
+ #
3658
+ # @!attribute [rw] number_value
3659
+ # A number data value.
3660
+ # @return [String]
3661
+ #
3662
+ # @!attribute [rw] datetime_value
3663
+ # A date and time value.
3664
+ # @return [Time]
3665
+ #
3666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedAttributeValue AWS API Documentation
3667
+ #
3668
+ class TypedAttributeValue < Struct.new(
3669
+ :string_value,
3670
+ :binary_value,
3671
+ :boolean_value,
3672
+ :number_value,
3673
+ :datetime_value)
3674
+ include Aws::Structure
3675
+ end
3676
+
3677
+ # A range of attribute values.
3678
+ #
3679
+ # @note When making an API call, you may pass TypedAttributeValueRange
3680
+ # data as a hash:
3681
+ #
3682
+ # {
3683
+ # start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
3684
+ # start_value: {
3685
+ # string_value: "StringAttributeValue",
3686
+ # binary_value: "data",
3687
+ # boolean_value: false,
3688
+ # number_value: "NumberAttributeValue",
3689
+ # datetime_value: Time.now,
3690
+ # },
3691
+ # end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
3692
+ # end_value: {
3693
+ # string_value: "StringAttributeValue",
3694
+ # binary_value: "data",
3695
+ # boolean_value: false,
3696
+ # number_value: "NumberAttributeValue",
3697
+ # datetime_value: Time.now,
3698
+ # },
3699
+ # }
3700
+ #
3701
+ # @!attribute [rw] start_mode
3702
+ # Inclusive or exclusive range start.
3703
+ # @return [String]
3704
+ #
3705
+ # @!attribute [rw] start_value
3706
+ # The value to start the range at.
3707
+ # @return [Types::TypedAttributeValue]
3708
+ #
3709
+ # @!attribute [rw] end_mode
3710
+ # Inclusive or exclusive range end.
3711
+ # @return [String]
3712
+ #
3713
+ # @!attribute [rw] end_value
3714
+ # The attribute value to terminate the range at.
3715
+ # @return [Types::TypedAttributeValue]
3716
+ #
3717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedAttributeValueRange AWS API Documentation
3718
+ #
3719
+ class TypedAttributeValueRange < Struct.new(
3720
+ :start_mode,
3721
+ :start_value,
3722
+ :end_mode,
3723
+ :end_value)
3724
+ include Aws::Structure
3725
+ end
3726
+
3727
+ # @note When making an API call, you may pass UntagResourceRequest
3728
+ # data as a hash:
3729
+ #
3730
+ # {
3731
+ # resource_arn: "Arn", # required
3732
+ # tag_keys: ["TagKey"], # required
3733
+ # }
3734
+ #
3735
+ # @!attribute [rw] resource_arn
3736
+ # ARN of the resource. Tagging is only supported for directories.
3737
+ # @return [String]
3738
+ #
3739
+ # @!attribute [rw] tag_keys
3740
+ # Keys of the tag that needs to be removed from the resource.
3741
+ # @return [Array<String>]
3742
+ #
3743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResourceRequest AWS API Documentation
3744
+ #
3745
+ class UntagResourceRequest < Struct.new(
3746
+ :resource_arn,
3747
+ :tag_keys)
3748
+ include Aws::Structure
3749
+ end
3750
+
3751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResourceResponse AWS API Documentation
3752
+ #
3753
+ class UntagResourceResponse < Aws::EmptyStructure; end
3754
+
3755
+ # @note When making an API call, you may pass UpdateFacetRequest
3756
+ # data as a hash:
3757
+ #
3758
+ # {
3759
+ # schema_arn: "Arn", # required
3760
+ # name: "FacetName", # required
3761
+ # attribute_updates: [
3762
+ # {
3763
+ # attribute: {
3764
+ # name: "AttributeName", # required
3765
+ # attribute_definition: {
3766
+ # type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
3767
+ # default_value: {
3768
+ # string_value: "StringAttributeValue",
3769
+ # binary_value: "data",
3770
+ # boolean_value: false,
3771
+ # number_value: "NumberAttributeValue",
3772
+ # datetime_value: Time.now,
3773
+ # },
3774
+ # is_immutable: false,
3775
+ # rules: {
3776
+ # "RuleKey" => {
3777
+ # type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
3778
+ # parameters: {
3779
+ # "RuleParameterKey" => "RuleParameterValue",
3780
+ # },
3781
+ # },
3782
+ # },
3783
+ # },
3784
+ # attribute_reference: {
3785
+ # target_facet_name: "FacetName", # required
3786
+ # target_attribute_name: "AttributeName", # required
3787
+ # },
3788
+ # required_behavior: "REQUIRED_ALWAYS", # accepts REQUIRED_ALWAYS, NOT_REQUIRED
3789
+ # },
3790
+ # action: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
3791
+ # },
3792
+ # ],
3793
+ # object_type: "NODE", # accepts NODE, LEAF_NODE, POLICY, INDEX
3794
+ # }
3795
+ #
3796
+ # @!attribute [rw] schema_arn
3797
+ # ARN associated with the Facet. For more information, see arns.
3798
+ # @return [String]
3799
+ #
3800
+ # @!attribute [rw] name
3801
+ # @return [String]
3802
+ #
3803
+ # @!attribute [rw] attribute_updates
3804
+ # List of attributes that need to be updated in a given schema Facet.
3805
+ # Each attribute is followed by AttributeAction, which specifies the
3806
+ # type of update operation to perform.
3807
+ # @return [Array<Types::FacetAttributeUpdate>]
3808
+ #
3809
+ # @!attribute [rw] object_type
3810
+ # Object type associated with the facet. See
3811
+ # CreateFacetRequest$ObjectType for more details.
3812
+ # @return [String]
3813
+ #
3814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateFacetRequest AWS API Documentation
3815
+ #
3816
+ class UpdateFacetRequest < Struct.new(
3817
+ :schema_arn,
3818
+ :name,
3819
+ :attribute_updates,
3820
+ :object_type)
3821
+ include Aws::Structure
3822
+ end
3823
+
3824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateFacetResponse AWS API Documentation
3825
+ #
3826
+ class UpdateFacetResponse < Aws::EmptyStructure; end
3827
+
3828
+ # @note When making an API call, you may pass UpdateObjectAttributesRequest
3829
+ # data as a hash:
3830
+ #
3831
+ # {
3832
+ # directory_arn: "Arn", # required
3833
+ # object_reference: { # required
3834
+ # selector: "SelectorObjectReference",
3835
+ # },
3836
+ # attribute_updates: [ # required
3837
+ # {
3838
+ # object_attribute_key: {
3839
+ # schema_arn: "Arn", # required
3840
+ # facet_name: "FacetName", # required
3841
+ # name: "AttributeName", # required
3842
+ # },
3843
+ # object_attribute_action: {
3844
+ # object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
3845
+ # object_attribute_update_value: {
3846
+ # string_value: "StringAttributeValue",
3847
+ # binary_value: "data",
3848
+ # boolean_value: false,
3849
+ # number_value: "NumberAttributeValue",
3850
+ # datetime_value: Time.now,
3851
+ # },
3852
+ # },
3853
+ # },
3854
+ # ],
3855
+ # }
3856
+ #
3857
+ # @!attribute [rw] directory_arn
3858
+ # ARN associated with the Directory where the object resides. For more
3859
+ # information, see arns.
3860
+ # @return [String]
3861
+ #
3862
+ # @!attribute [rw] object_reference
3863
+ # Reference that identifies the object.
3864
+ # @return [Types::ObjectReference]
3865
+ #
3866
+ # @!attribute [rw] attribute_updates
3867
+ # Attributes update structure.
3868
+ # @return [Array<Types::ObjectAttributeUpdate>]
3869
+ #
3870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesRequest AWS API Documentation
3871
+ #
3872
+ class UpdateObjectAttributesRequest < Struct.new(
3873
+ :directory_arn,
3874
+ :object_reference,
3875
+ :attribute_updates)
3876
+ include Aws::Structure
3877
+ end
3878
+
3879
+ # @!attribute [rw] object_identifier
3880
+ # ObjectIdentifier of the updated object.
3881
+ # @return [String]
3882
+ #
3883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesResponse AWS API Documentation
3884
+ #
3885
+ class UpdateObjectAttributesResponse < Struct.new(
3886
+ :object_identifier)
3887
+ include Aws::Structure
3888
+ end
3889
+
3890
+ # @note When making an API call, you may pass UpdateSchemaRequest
3891
+ # data as a hash:
3892
+ #
3893
+ # {
3894
+ # schema_arn: "Arn", # required
3895
+ # name: "SchemaName", # required
3896
+ # }
3897
+ #
3898
+ # @!attribute [rw] schema_arn
3899
+ # ARN of the development schema. For more information, see arns.
3900
+ # @return [String]
3901
+ #
3902
+ # @!attribute [rw] name
3903
+ # Name of the schema.
3904
+ # @return [String]
3905
+ #
3906
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaRequest AWS API Documentation
3907
+ #
3908
+ class UpdateSchemaRequest < Struct.new(
3909
+ :schema_arn,
3910
+ :name)
3911
+ include Aws::Structure
3912
+ end
3913
+
3914
+ # @!attribute [rw] schema_arn
3915
+ # ARN associated with the updated schema. For more information, see
3916
+ # arns.
3917
+ # @return [String]
3918
+ #
3919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaResponse AWS API Documentation
3920
+ #
3921
+ class UpdateSchemaResponse < Struct.new(
3922
+ :schema_arn)
3923
+ include Aws::Structure
3924
+ end
3925
+
3926
+ end
3927
+ end