aws-sdk-clouddirectory 1.0.0.rc5 → 1.0.0.rc6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-clouddirectory/client.rb +802 -129
- data/lib/aws-sdk-clouddirectory/client_api.rb +356 -0
- data/lib/aws-sdk-clouddirectory/types.rb +1301 -274
- data/lib/aws-sdk-clouddirectory.rb +1 -1
- metadata +4 -4
@@ -39,8 +39,8 @@ module Aws::CloudDirectory
|
|
39
39
|
# }
|
40
40
|
#
|
41
41
|
# @!attribute [rw] directory_arn
|
42
|
-
#
|
43
|
-
# information, see arns.
|
42
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
43
|
+
# where the object resides. For more information, see arns.
|
44
44
|
# @return [String]
|
45
45
|
#
|
46
46
|
# @!attribute [rw] schema_facet
|
@@ -48,7 +48,7 @@ module Aws::CloudDirectory
|
|
48
48
|
# @return [Types::SchemaFacet]
|
49
49
|
#
|
50
50
|
# @!attribute [rw] object_attribute_list
|
51
|
-
# Attributes on the facet you are adding to the object.
|
51
|
+
# Attributes on the facet that you are adding to the object.
|
52
52
|
# @return [Array<Types::AttributeKeyAndValue>]
|
53
53
|
#
|
54
54
|
# @!attribute [rw] object_reference
|
@@ -78,13 +78,13 @@ module Aws::CloudDirectory
|
|
78
78
|
# }
|
79
79
|
#
|
80
80
|
# @!attribute [rw] published_schema_arn
|
81
|
-
# Published schema ARN that needs to be copied.
|
82
|
-
# see arns.
|
81
|
+
# Published schema Amazon Resource Name (ARN) that needs to be copied.
|
82
|
+
# For more information, see arns.
|
83
83
|
# @return [String]
|
84
84
|
#
|
85
85
|
# @!attribute [rw] directory_arn
|
86
|
-
#
|
87
|
-
# For more information, see arns.
|
86
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
87
|
+
# into which the schema is copied. For more information, see arns.
|
88
88
|
# @return [String]
|
89
89
|
#
|
90
90
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaRequest AWS API Documentation
|
@@ -96,13 +96,15 @@ module Aws::CloudDirectory
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# @!attribute [rw] applied_schema_arn
|
99
|
-
#
|
100
|
-
# Directory. You can use this ARN to describe the schema
|
101
|
-
# applied on this directory. For more information, see
|
99
|
+
# The applied schema ARN that is associated with the copied schema in
|
100
|
+
# the Directory. You can use this ARN to describe the schema
|
101
|
+
# information applied on this directory. For more information, see
|
102
|
+
# arns.
|
102
103
|
# @return [String]
|
103
104
|
#
|
104
105
|
# @!attribute [rw] directory_arn
|
105
|
-
# ARN associated with the Directory. For more information,
|
106
|
+
# The ARN that is associated with the Directory. For more information,
|
107
|
+
# see arns.
|
106
108
|
# @return [String]
|
107
109
|
#
|
108
110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaResponse AWS API Documentation
|
@@ -128,20 +130,20 @@ module Aws::CloudDirectory
|
|
128
130
|
# }
|
129
131
|
#
|
130
132
|
# @!attribute [rw] directory_arn
|
131
|
-
# ARN associated with the Directory
|
132
|
-
# more information, see arns.
|
133
|
+
# Amazon Resource Name (ARN) that is associated with the Directory
|
134
|
+
# where both objects reside. For more information, see arns.
|
133
135
|
# @return [String]
|
134
136
|
#
|
135
137
|
# @!attribute [rw] parent_reference
|
136
|
-
#
|
138
|
+
# The parent object reference.
|
137
139
|
# @return [Types::ObjectReference]
|
138
140
|
#
|
139
141
|
# @!attribute [rw] child_reference
|
140
|
-
#
|
142
|
+
# The child object reference to be attached to the object.
|
141
143
|
# @return [Types::ObjectReference]
|
142
144
|
#
|
143
145
|
# @!attribute [rw] link_name
|
144
|
-
#
|
146
|
+
# The link name with which the child object is attached to the parent.
|
145
147
|
# @return [String]
|
146
148
|
#
|
147
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectRequest AWS API Documentation
|
@@ -155,7 +157,8 @@ module Aws::CloudDirectory
|
|
155
157
|
end
|
156
158
|
|
157
159
|
# @!attribute [rw] attached_object_identifier
|
158
|
-
#
|
160
|
+
# The attached `ObjectIdentifier`, which is the child
|
161
|
+
# `ObjectIdentifier`.
|
159
162
|
# @return [String]
|
160
163
|
#
|
161
164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectResponse AWS API Documentation
|
@@ -179,16 +182,16 @@ module Aws::CloudDirectory
|
|
179
182
|
# }
|
180
183
|
#
|
181
184
|
# @!attribute [rw] directory_arn
|
182
|
-
# ARN associated with the Directory
|
183
|
-
# more information, see arns.
|
185
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
186
|
+
# where both objects reside. For more information, see arns.
|
184
187
|
# @return [String]
|
185
188
|
#
|
186
189
|
# @!attribute [rw] policy_reference
|
187
|
-
#
|
190
|
+
# The reference that is associated with the policy object.
|
188
191
|
# @return [Types::ObjectReference]
|
189
192
|
#
|
190
193
|
# @!attribute [rw] object_reference
|
191
|
-
#
|
194
|
+
# The reference that identifies the object to which the policy will be
|
192
195
|
# attached.
|
193
196
|
# @return [Types::ObjectReference]
|
194
197
|
#
|
@@ -219,7 +222,8 @@ module Aws::CloudDirectory
|
|
219
222
|
# }
|
220
223
|
#
|
221
224
|
# @!attribute [rw] directory_arn
|
222
|
-
# The ARN of the directory where the object and
|
225
|
+
# The Amazon Resource Name (ARN) of the directory where the object and
|
226
|
+
# index exist.
|
223
227
|
# @return [String]
|
224
228
|
#
|
225
229
|
# @!attribute [rw] index_reference
|
@@ -250,6 +254,79 @@ module Aws::CloudDirectory
|
|
250
254
|
include Aws::Structure
|
251
255
|
end
|
252
256
|
|
257
|
+
# @note When making an API call, you may pass AttachTypedLinkRequest
|
258
|
+
# data as a hash:
|
259
|
+
#
|
260
|
+
# {
|
261
|
+
# directory_arn: "Arn", # required
|
262
|
+
# source_object_reference: { # required
|
263
|
+
# selector: "SelectorObjectReference",
|
264
|
+
# },
|
265
|
+
# target_object_reference: { # required
|
266
|
+
# selector: "SelectorObjectReference",
|
267
|
+
# },
|
268
|
+
# typed_link_facet: { # required
|
269
|
+
# schema_arn: "Arn", # required
|
270
|
+
# typed_link_name: "TypedLinkName", # required
|
271
|
+
# },
|
272
|
+
# attributes: [ # required
|
273
|
+
# {
|
274
|
+
# attribute_name: "AttributeName", # required
|
275
|
+
# value: { # required
|
276
|
+
# string_value: "StringAttributeValue",
|
277
|
+
# binary_value: "data",
|
278
|
+
# boolean_value: false,
|
279
|
+
# number_value: "NumberAttributeValue",
|
280
|
+
# datetime_value: Time.now,
|
281
|
+
# },
|
282
|
+
# },
|
283
|
+
# ],
|
284
|
+
# }
|
285
|
+
#
|
286
|
+
# @!attribute [rw] directory_arn
|
287
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
288
|
+
# attach the typed link.
|
289
|
+
# @return [String]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] source_object_reference
|
292
|
+
# Identifies the source object that the typed link will attach to.
|
293
|
+
# @return [Types::ObjectReference]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] target_object_reference
|
296
|
+
# Identifies the target object that the typed link will attach to.
|
297
|
+
# @return [Types::ObjectReference]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] typed_link_facet
|
300
|
+
# Identifies the typed link facet that is associated with the typed
|
301
|
+
# link.
|
302
|
+
# @return [Types::TypedLinkSchemaAndFacetName]
|
303
|
+
#
|
304
|
+
# @!attribute [rw] attributes
|
305
|
+
# A set of attributes that are associated with the typed link.
|
306
|
+
# @return [Array<Types::AttributeNameAndValue>]
|
307
|
+
#
|
308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachTypedLinkRequest AWS API Documentation
|
309
|
+
#
|
310
|
+
class AttachTypedLinkRequest < Struct.new(
|
311
|
+
:directory_arn,
|
312
|
+
:source_object_reference,
|
313
|
+
:target_object_reference,
|
314
|
+
:typed_link_facet,
|
315
|
+
:attributes)
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# @!attribute [rw] typed_link_specifier
|
320
|
+
# Returns a typed link specifier as output.
|
321
|
+
# @return [Types::TypedLinkSpecifier]
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachTypedLinkResponse AWS API Documentation
|
324
|
+
#
|
325
|
+
class AttachTypedLinkResponse < Struct.new(
|
326
|
+
:typed_link_specifier)
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
253
330
|
# A unique identifier for an attribute.
|
254
331
|
#
|
255
332
|
# @note When making an API call, you may pass AttributeKey
|
@@ -262,11 +339,12 @@ module Aws::CloudDirectory
|
|
262
339
|
# }
|
263
340
|
#
|
264
341
|
# @!attribute [rw] schema_arn
|
265
|
-
# The ARN of the schema that contains the facet
|
342
|
+
# The Amazon Resource Name (ARN) of the schema that contains the facet
|
343
|
+
# and attribute.
|
266
344
|
# @return [String]
|
267
345
|
#
|
268
346
|
# @!attribute [rw] facet_name
|
269
|
-
# The name of the facet the attribute exists within.
|
347
|
+
# The name of the facet that the attribute exists within.
|
270
348
|
# @return [String]
|
271
349
|
#
|
272
350
|
# @!attribute [rw] name
|
@@ -318,6 +396,38 @@ module Aws::CloudDirectory
|
|
318
396
|
include Aws::Structure
|
319
397
|
end
|
320
398
|
|
399
|
+
# Identifies the attribute name and value for a typed link.
|
400
|
+
#
|
401
|
+
# @note When making an API call, you may pass AttributeNameAndValue
|
402
|
+
# data as a hash:
|
403
|
+
#
|
404
|
+
# {
|
405
|
+
# attribute_name: "AttributeName", # required
|
406
|
+
# value: { # required
|
407
|
+
# string_value: "StringAttributeValue",
|
408
|
+
# binary_value: "data",
|
409
|
+
# boolean_value: false,
|
410
|
+
# number_value: "NumberAttributeValue",
|
411
|
+
# datetime_value: Time.now,
|
412
|
+
# },
|
413
|
+
# }
|
414
|
+
#
|
415
|
+
# @!attribute [rw] attribute_name
|
416
|
+
# The attribute name of the typed link.
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] value
|
420
|
+
# The value for the typed link.
|
421
|
+
# @return [Types::TypedAttributeValue]
|
422
|
+
#
|
423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttributeNameAndValue AWS API Documentation
|
424
|
+
#
|
425
|
+
class AttributeNameAndValue < Struct.new(
|
426
|
+
:attribute_name,
|
427
|
+
:value)
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
321
431
|
# Represents the output of a batch add facet to object operation.
|
322
432
|
#
|
323
433
|
# @note When making an API call, you may pass BatchAddFacetToObject
|
@@ -376,7 +486,7 @@ module Aws::CloudDirectory
|
|
376
486
|
#
|
377
487
|
class BatchAddFacetToObjectResponse < Aws::EmptyStructure; end
|
378
488
|
|
379
|
-
# Represents the output of an AttachObject operation.
|
489
|
+
# Represents the output of an `AttachObject` operation.
|
380
490
|
#
|
381
491
|
# @note When making an API call, you may pass BatchAttachObject
|
382
492
|
# data as a hash:
|
@@ -392,11 +502,11 @@ module Aws::CloudDirectory
|
|
392
502
|
# }
|
393
503
|
#
|
394
504
|
# @!attribute [rw] parent_reference
|
395
|
-
#
|
505
|
+
# The parent object reference.
|
396
506
|
# @return [Types::ObjectReference]
|
397
507
|
#
|
398
508
|
# @!attribute [rw] child_reference
|
399
|
-
#
|
509
|
+
# The child object reference that is to be attached to the object.
|
400
510
|
# @return [Types::ObjectReference]
|
401
511
|
#
|
402
512
|
# @!attribute [rw] link_name
|
@@ -412,7 +522,7 @@ module Aws::CloudDirectory
|
|
412
522
|
include Aws::Structure
|
413
523
|
end
|
414
524
|
|
415
|
-
# Represents the output batch AttachObject response operation.
|
525
|
+
# Represents the output batch `AttachObject` response operation.
|
416
526
|
#
|
417
527
|
# @!attribute [rw] attached_object_identifier
|
418
528
|
# The `ObjectIdentifier` of the object that has been attached.
|
@@ -425,7 +535,7 @@ module Aws::CloudDirectory
|
|
425
535
|
include Aws::Structure
|
426
536
|
end
|
427
537
|
|
428
|
-
# Represents the output of a CreateObject operation.
|
538
|
+
# Represents the output of a `CreateObject` operation.
|
429
539
|
#
|
430
540
|
# @note When making an API call, you may pass BatchCreateObject
|
431
541
|
# data as a hash:
|
@@ -461,12 +571,12 @@ module Aws::CloudDirectory
|
|
461
571
|
# }
|
462
572
|
#
|
463
573
|
# @!attribute [rw] schema_facet
|
464
|
-
#
|
465
|
-
# information, see arns.
|
574
|
+
# A list of `FacetArns` that will be associated with the object. For
|
575
|
+
# more information, see arns.
|
466
576
|
# @return [Array<Types::SchemaFacet>]
|
467
577
|
#
|
468
578
|
# @!attribute [rw] object_attribute_list
|
469
|
-
#
|
579
|
+
# An attribute map, which contains an attribute ARN as the key and
|
470
580
|
# attribute value as the map value.
|
471
581
|
# @return [Array<Types::AttributeKeyAndValue>]
|
472
582
|
#
|
@@ -501,7 +611,7 @@ module Aws::CloudDirectory
|
|
501
611
|
# Represents the output of a `CreateObject` response operation.
|
502
612
|
#
|
503
613
|
# @!attribute [rw] object_identifier
|
504
|
-
# ID associated with the object.
|
614
|
+
# The ID that is associated with the object.
|
505
615
|
# @return [String]
|
506
616
|
#
|
507
617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchCreateObjectResponse AWS API Documentation
|
@@ -523,7 +633,7 @@ module Aws::CloudDirectory
|
|
523
633
|
# }
|
524
634
|
#
|
525
635
|
# @!attribute [rw] object_reference
|
526
|
-
#
|
636
|
+
# The reference that identifies the object.
|
527
637
|
# @return [Types::ObjectReference]
|
528
638
|
#
|
529
639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDeleteObject AWS API Documentation
|
@@ -617,13 +727,13 @@ module Aws::CloudDirectory
|
|
617
727
|
# @return [String]
|
618
728
|
#
|
619
729
|
# @!attribute [rw] max_results
|
620
|
-
#
|
621
|
-
# approximate number.
|
730
|
+
# The maximum number of items to be retrieved in a single call. This
|
731
|
+
# is an approximate number.
|
622
732
|
# @return [Integer]
|
623
733
|
#
|
624
734
|
# @!attribute [rw] facet_filter
|
625
|
-
# Used to filter the list of object attributes
|
626
|
-
# certain facet.
|
735
|
+
# Used to filter the list of object attributes that are associated
|
736
|
+
# with a certain facet.
|
627
737
|
# @return [Types::SchemaFacet]
|
628
738
|
#
|
629
739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectAttributes AWS API Documentation
|
@@ -639,8 +749,8 @@ module Aws::CloudDirectory
|
|
639
749
|
# Represents the output of a `ListObjectAttributes` response operation.
|
640
750
|
#
|
641
751
|
# @!attribute [rw] attributes
|
642
|
-
#
|
643
|
-
# key; attribute value is the value.
|
752
|
+
# The attributes map that is associated with the object.
|
753
|
+
# `AttributeArn` is the key; attribute value is the value.
|
644
754
|
# @return [Array<Types::AttributeKeyAndValue>]
|
645
755
|
#
|
646
756
|
# @!attribute [rw] next_token
|
@@ -693,8 +803,8 @@ module Aws::CloudDirectory
|
|
693
803
|
# Represents the output of a `ListObjectChildren` response operation.
|
694
804
|
#
|
695
805
|
# @!attribute [rw] children
|
696
|
-
#
|
697
|
-
# `ObjectIdentifier` as the value.
|
806
|
+
# The children structure, which is a map with the key as the
|
807
|
+
# `LinkName` and `ObjectIdentifier` as the value.
|
698
808
|
# @return [Hash<String,String>]
|
699
809
|
#
|
700
810
|
# @!attribute [rw] next_token
|
@@ -709,15 +819,15 @@ module Aws::CloudDirectory
|
|
709
819
|
include Aws::Structure
|
710
820
|
end
|
711
821
|
|
712
|
-
#
|
713
|
-
# message.
|
822
|
+
# The batch read exception structure, which contains the exception type
|
823
|
+
# and message.
|
714
824
|
#
|
715
825
|
# @!attribute [rw] type
|
716
|
-
#
|
826
|
+
# A type of exception, such as `InvalidArnException`.
|
717
827
|
# @return [String]
|
718
828
|
#
|
719
829
|
# @!attribute [rw] message
|
720
|
-
#
|
830
|
+
# An exception message that is associated with the failure.
|
721
831
|
# @return [String]
|
722
832
|
#
|
723
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadException AWS API Documentation
|
@@ -755,7 +865,7 @@ module Aws::CloudDirectory
|
|
755
865
|
# }
|
756
866
|
#
|
757
867
|
# @!attribute [rw] list_object_attributes
|
758
|
-
# Lists all attributes associated with an object.
|
868
|
+
# Lists all attributes that are associated with an object.
|
759
869
|
# @return [Types::BatchListObjectAttributes]
|
760
870
|
#
|
761
871
|
# @!attribute [rw] list_object_children
|
@@ -820,11 +930,12 @@ module Aws::CloudDirectory
|
|
820
930
|
# }
|
821
931
|
#
|
822
932
|
# @!attribute [rw] directory_arn
|
823
|
-
#
|
933
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
934
|
+
# Directory. For more information, see arns.
|
824
935
|
# @return [String]
|
825
936
|
#
|
826
937
|
# @!attribute [rw] operations
|
827
|
-
#
|
938
|
+
# A list of operations that are part of the batch.
|
828
939
|
# @return [Array<Types::BatchReadOperation>]
|
829
940
|
#
|
830
941
|
# @!attribute [rw] consistency_level
|
@@ -843,7 +954,7 @@ module Aws::CloudDirectory
|
|
843
954
|
end
|
844
955
|
|
845
956
|
# @!attribute [rw] responses
|
846
|
-
#
|
957
|
+
# A list of all the responses for each batch read.
|
847
958
|
# @return [Array<Types::BatchReadOperationResponse>]
|
848
959
|
#
|
849
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadResponse AWS API Documentation
|
@@ -856,12 +967,12 @@ module Aws::CloudDirectory
|
|
856
967
|
# Represents the output of a `BatchRead` success response operation.
|
857
968
|
#
|
858
969
|
# @!attribute [rw] list_object_attributes
|
859
|
-
# Lists all attributes associated with an object.
|
970
|
+
# Lists all attributes that are associated with an object.
|
860
971
|
# @return [Types::BatchListObjectAttributesResponse]
|
861
972
|
#
|
862
973
|
# @!attribute [rw] list_object_children
|
863
|
-
# Returns a paginated list of child objects associated with a
|
864
|
-
# object.
|
974
|
+
# Returns a paginated list of child objects that are associated with a
|
975
|
+
# given object.
|
865
976
|
# @return [Types::BatchListObjectChildrenResponse]
|
866
977
|
#
|
867
978
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadSuccessfulResponse AWS API Documentation
|
@@ -872,7 +983,7 @@ module Aws::CloudDirectory
|
|
872
983
|
include Aws::Structure
|
873
984
|
end
|
874
985
|
|
875
|
-
#
|
986
|
+
# A batch operation to remove a facet from an object.
|
876
987
|
#
|
877
988
|
# @note When making an API call, you may pass BatchRemoveFacetFromObject
|
878
989
|
# data as a hash:
|
@@ -903,7 +1014,7 @@ module Aws::CloudDirectory
|
|
903
1014
|
include Aws::Structure
|
904
1015
|
end
|
905
1016
|
|
906
|
-
#
|
1017
|
+
# An empty result that represents success.
|
907
1018
|
#
|
908
1019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRemoveFacetFromObjectResponse AWS API Documentation
|
909
1020
|
#
|
@@ -958,7 +1069,7 @@ module Aws::CloudDirectory
|
|
958
1069
|
# Represents the output of a `BatchUpdate` response operation.
|
959
1070
|
#
|
960
1071
|
# @!attribute [rw] object_identifier
|
961
|
-
# ID associated with the object.
|
1072
|
+
# ID that is associated with the object.
|
962
1073
|
# @return [String]
|
963
1074
|
#
|
964
1075
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchUpdateObjectAttributesResponse AWS API Documentation
|
@@ -1097,7 +1208,7 @@ module Aws::CloudDirectory
|
|
1097
1208
|
# @return [Types::BatchDetachObject]
|
1098
1209
|
#
|
1099
1210
|
# @!attribute [rw] update_object_attributes
|
1100
|
-
#
|
1211
|
+
# Updates a given object's attributes.
|
1101
1212
|
# @return [Types::BatchUpdateObjectAttributes]
|
1102
1213
|
#
|
1103
1214
|
# @!attribute [rw] delete_object
|
@@ -1105,11 +1216,11 @@ module Aws::CloudDirectory
|
|
1105
1216
|
# @return [Types::BatchDeleteObject]
|
1106
1217
|
#
|
1107
1218
|
# @!attribute [rw] add_facet_to_object
|
1108
|
-
#
|
1219
|
+
# A batch operation that adds a facet to an object.
|
1109
1220
|
# @return [Types::BatchAddFacetToObject]
|
1110
1221
|
#
|
1111
1222
|
# @!attribute [rw] remove_facet_from_object
|
1112
|
-
#
|
1223
|
+
# A batch operation that removes a facet from an object.
|
1113
1224
|
# @return [Types::BatchRemoveFacetFromObject]
|
1114
1225
|
#
|
1115
1226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperation AWS API Documentation
|
@@ -1148,11 +1259,11 @@ module Aws::CloudDirectory
|
|
1148
1259
|
# @return [Types::BatchDeleteObjectResponse]
|
1149
1260
|
#
|
1150
1261
|
# @!attribute [rw] add_facet_to_object
|
1151
|
-
#
|
1262
|
+
# The result of an add facet to object batch operation.
|
1152
1263
|
# @return [Types::BatchAddFacetToObjectResponse]
|
1153
1264
|
#
|
1154
1265
|
# @!attribute [rw] remove_facet_from_object
|
1155
|
-
#
|
1266
|
+
# The result of a batch remove facet from object operation.
|
1156
1267
|
# @return [Types::BatchRemoveFacetFromObjectResponse]
|
1157
1268
|
#
|
1158
1269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperationResponse AWS API Documentation
|
@@ -1288,11 +1399,12 @@ module Aws::CloudDirectory
|
|
1288
1399
|
# }
|
1289
1400
|
#
|
1290
1401
|
# @!attribute [rw] directory_arn
|
1291
|
-
#
|
1402
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
1403
|
+
# Directory. For more information, see arns.
|
1292
1404
|
# @return [String]
|
1293
1405
|
#
|
1294
1406
|
# @!attribute [rw] operations
|
1295
|
-
#
|
1407
|
+
# A list of operations that are part of the batch.
|
1296
1408
|
# @return [Array<Types::BatchWriteOperation>]
|
1297
1409
|
#
|
1298
1410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteRequest AWS API Documentation
|
@@ -1304,7 +1416,7 @@ module Aws::CloudDirectory
|
|
1304
1416
|
end
|
1305
1417
|
|
1306
1418
|
# @!attribute [rw] responses
|
1307
|
-
#
|
1419
|
+
# A list of all the responses for each batch write.
|
1308
1420
|
# @return [Array<Types::BatchWriteOperationResponse>]
|
1309
1421
|
#
|
1310
1422
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteResponse AWS API Documentation
|
@@ -1323,12 +1435,12 @@ module Aws::CloudDirectory
|
|
1323
1435
|
# }
|
1324
1436
|
#
|
1325
1437
|
# @!attribute [rw] name
|
1326
|
-
#
|
1438
|
+
# The name of the Directory. Should be unique per account, per region.
|
1327
1439
|
# @return [String]
|
1328
1440
|
#
|
1329
1441
|
# @!attribute [rw] schema_arn
|
1330
|
-
# ARN of the published schema that will be
|
1331
|
-
# Directory. For more information, see arns.
|
1442
|
+
# The Amazon Resource Name (ARN) of the published schema that will be
|
1443
|
+
# copied into the data Directory. For more information, see arns.
|
1332
1444
|
# @return [String]
|
1333
1445
|
#
|
1334
1446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectoryRequest AWS API Documentation
|
@@ -1340,11 +1452,12 @@ module Aws::CloudDirectory
|
|
1340
1452
|
end
|
1341
1453
|
|
1342
1454
|
# @!attribute [rw] directory_arn
|
1343
|
-
# ARN associated with the Directory. For more information,
|
1455
|
+
# The ARN that is associated with the Directory. For more information,
|
1456
|
+
# see arns.
|
1344
1457
|
# @return [String]
|
1345
1458
|
#
|
1346
1459
|
# @!attribute [rw] name
|
1347
|
-
#
|
1460
|
+
# The name of the Directory.
|
1348
1461
|
# @return [String]
|
1349
1462
|
#
|
1350
1463
|
# @!attribute [rw] object_identifier
|
@@ -1352,8 +1465,8 @@ module Aws::CloudDirectory
|
|
1352
1465
|
# @return [String]
|
1353
1466
|
#
|
1354
1467
|
# @!attribute [rw] applied_schema_arn
|
1355
|
-
# ARN of the published schema in the Directory. Once a published
|
1356
|
-
# schema is copied into the directory, it has its own ARN which is
|
1468
|
+
# The ARN of the published schema in the Directory. Once a published
|
1469
|
+
# schema is copied into the directory, it has its own ARN, which is
|
1357
1470
|
# referred to applied schema ARN. For more information, see arns.
|
1358
1471
|
# @return [String]
|
1359
1472
|
#
|
@@ -1406,28 +1519,28 @@ module Aws::CloudDirectory
|
|
1406
1519
|
# }
|
1407
1520
|
#
|
1408
1521
|
# @!attribute [rw] schema_arn
|
1409
|
-
#
|
1522
|
+
# The schema ARN in which the new Facet will be created. For more
|
1410
1523
|
# information, see arns.
|
1411
1524
|
# @return [String]
|
1412
1525
|
#
|
1413
1526
|
# @!attribute [rw] name
|
1414
|
-
#
|
1527
|
+
# The name of the Facet, which is unique for a given schema.
|
1415
1528
|
# @return [String]
|
1416
1529
|
#
|
1417
1530
|
# @!attribute [rw] attributes
|
1418
|
-
#
|
1531
|
+
# The attributes that are associated with the Facet.
|
1419
1532
|
# @return [Array<Types::FacetAttribute>]
|
1420
1533
|
#
|
1421
1534
|
# @!attribute [rw] object_type
|
1422
1535
|
# Specifies whether a given object created from this facet is of type
|
1423
|
-
#
|
1536
|
+
# node, leaf node, policy or index.
|
1424
1537
|
#
|
1425
1538
|
# * Node: Can have multiple children but one parent.
|
1426
1539
|
#
|
1427
1540
|
# ^
|
1428
1541
|
# ^
|
1429
1542
|
#
|
1430
|
-
# * Leaf
|
1543
|
+
# * Leaf node: Cannot have children but can have multiple parents.
|
1431
1544
|
#
|
1432
1545
|
# ^
|
1433
1546
|
# ^
|
@@ -1485,13 +1598,13 @@ module Aws::CloudDirectory
|
|
1485
1598
|
# @return [String]
|
1486
1599
|
#
|
1487
1600
|
# @!attribute [rw] ordered_indexed_attribute_list
|
1488
|
-
# Specifies the
|
1601
|
+
# Specifies the attributes that should be indexed on. Currently only a
|
1489
1602
|
# single attribute is supported.
|
1490
1603
|
# @return [Array<Types::AttributeKey>]
|
1491
1604
|
#
|
1492
1605
|
# @!attribute [rw] is_unique
|
1493
|
-
# Indicates whether
|
1494
|
-
#
|
1606
|
+
# Indicates whether the attribute that is being indexed has unique
|
1607
|
+
# values or not.
|
1495
1608
|
# @return [Boolean]
|
1496
1609
|
#
|
1497
1610
|
# @!attribute [rw] parent_reference
|
@@ -1558,17 +1671,17 @@ module Aws::CloudDirectory
|
|
1558
1671
|
# }
|
1559
1672
|
#
|
1560
1673
|
# @!attribute [rw] directory_arn
|
1561
|
-
#
|
1562
|
-
# created. For more information, see arns.
|
1674
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
1675
|
+
# in which the object will be created. For more information, see arns.
|
1563
1676
|
# @return [String]
|
1564
1677
|
#
|
1565
1678
|
# @!attribute [rw] schema_facets
|
1566
|
-
#
|
1567
|
-
# information, see arns.
|
1679
|
+
# A list of schema facets to be associated with the object that
|
1680
|
+
# contains `SchemaArn` and facet name. For more information, see arns.
|
1568
1681
|
# @return [Array<Types::SchemaFacet>]
|
1569
1682
|
#
|
1570
1683
|
# @!attribute [rw] object_attribute_list
|
1571
|
-
#
|
1684
|
+
# The attribute map whose attribute ARN contains the key and attribute
|
1572
1685
|
# value as the map value.
|
1573
1686
|
# @return [Array<Types::AttributeKeyAndValue>]
|
1574
1687
|
#
|
@@ -1593,7 +1706,7 @@ module Aws::CloudDirectory
|
|
1593
1706
|
end
|
1594
1707
|
|
1595
1708
|
# @!attribute [rw] object_identifier
|
1596
|
-
#
|
1709
|
+
# The identifier that is associated with the object.
|
1597
1710
|
# @return [String]
|
1598
1711
|
#
|
1599
1712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObjectResponse AWS API Documentation
|
@@ -1611,8 +1724,8 @@ module Aws::CloudDirectory
|
|
1611
1724
|
# }
|
1612
1725
|
#
|
1613
1726
|
# @!attribute [rw] name
|
1614
|
-
#
|
1615
|
-
# in each region.
|
1727
|
+
# The name that is associated with the schema. This is unique to each
|
1728
|
+
# account and in each region.
|
1616
1729
|
# @return [String]
|
1617
1730
|
#
|
1618
1731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaRequest AWS API Documentation
|
@@ -1623,7 +1736,8 @@ module Aws::CloudDirectory
|
|
1623
1736
|
end
|
1624
1737
|
|
1625
1738
|
# @!attribute [rw] schema_arn
|
1626
|
-
# ARN associated with the schema.
|
1739
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
1740
|
+
# For more information, see arns.
|
1627
1741
|
# @return [String]
|
1628
1742
|
#
|
1629
1743
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaResponse AWS API Documentation
|
@@ -1633,6 +1747,61 @@ module Aws::CloudDirectory
|
|
1633
1747
|
include Aws::Structure
|
1634
1748
|
end
|
1635
1749
|
|
1750
|
+
# @note When making an API call, you may pass CreateTypedLinkFacetRequest
|
1751
|
+
# data as a hash:
|
1752
|
+
#
|
1753
|
+
# {
|
1754
|
+
# schema_arn: "Arn", # required
|
1755
|
+
# facet: { # required
|
1756
|
+
# name: "TypedLinkName", # required
|
1757
|
+
# attributes: [ # required
|
1758
|
+
# {
|
1759
|
+
# name: "AttributeName", # required
|
1760
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
1761
|
+
# default_value: {
|
1762
|
+
# string_value: "StringAttributeValue",
|
1763
|
+
# binary_value: "data",
|
1764
|
+
# boolean_value: false,
|
1765
|
+
# number_value: "NumberAttributeValue",
|
1766
|
+
# datetime_value: Time.now,
|
1767
|
+
# },
|
1768
|
+
# is_immutable: false,
|
1769
|
+
# rules: {
|
1770
|
+
# "RuleKey" => {
|
1771
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
1772
|
+
# parameters: {
|
1773
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
1774
|
+
# },
|
1775
|
+
# },
|
1776
|
+
# },
|
1777
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
1778
|
+
# },
|
1779
|
+
# ],
|
1780
|
+
# identity_attribute_order: ["AttributeName"], # required
|
1781
|
+
# },
|
1782
|
+
# }
|
1783
|
+
#
|
1784
|
+
# @!attribute [rw] schema_arn
|
1785
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
1786
|
+
# For more information, see arns.
|
1787
|
+
# @return [String]
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] facet
|
1790
|
+
# Facet structure that is associated with the typed link facet.
|
1791
|
+
# @return [Types::TypedLinkFacet]
|
1792
|
+
#
|
1793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateTypedLinkFacetRequest AWS API Documentation
|
1794
|
+
#
|
1795
|
+
class CreateTypedLinkFacetRequest < Struct.new(
|
1796
|
+
:schema_arn,
|
1797
|
+
:facet)
|
1798
|
+
include Aws::Structure
|
1799
|
+
end
|
1800
|
+
|
1801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateTypedLinkFacetResponse AWS API Documentation
|
1802
|
+
#
|
1803
|
+
class CreateTypedLinkFacetResponse < Aws::EmptyStructure; end
|
1804
|
+
|
1636
1805
|
# @note When making an API call, you may pass DeleteDirectoryRequest
|
1637
1806
|
# data as a hash:
|
1638
1807
|
#
|
@@ -1671,7 +1840,8 @@ module Aws::CloudDirectory
|
|
1671
1840
|
# }
|
1672
1841
|
#
|
1673
1842
|
# @!attribute [rw] schema_arn
|
1674
|
-
# ARN associated with the Facet.
|
1843
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet.
|
1844
|
+
# For more information, see arns.
|
1675
1845
|
# @return [String]
|
1676
1846
|
#
|
1677
1847
|
# @!attribute [rw] name
|
@@ -1701,12 +1871,12 @@ module Aws::CloudDirectory
|
|
1701
1871
|
# }
|
1702
1872
|
#
|
1703
1873
|
# @!attribute [rw] directory_arn
|
1704
|
-
#
|
1705
|
-
# information, see arns.
|
1874
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
1875
|
+
# where the object resides. For more information, see arns.
|
1706
1876
|
# @return [String]
|
1707
1877
|
#
|
1708
1878
|
# @!attribute [rw] object_reference
|
1709
|
-
#
|
1879
|
+
# A reference that identifies the object.
|
1710
1880
|
# @return [Types::ObjectReference]
|
1711
1881
|
#
|
1712
1882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObjectRequest AWS API Documentation
|
@@ -1729,7 +1899,8 @@ module Aws::CloudDirectory
|
|
1729
1899
|
# }
|
1730
1900
|
#
|
1731
1901
|
# @!attribute [rw] schema_arn
|
1732
|
-
# ARN of the development schema. For more
|
1902
|
+
# The Amazon Resource Name (ARN) of the development schema. For more
|
1903
|
+
# information, see arns.
|
1733
1904
|
# @return [String]
|
1734
1905
|
#
|
1735
1906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchemaRequest AWS API Documentation
|
@@ -1740,7 +1911,7 @@ module Aws::CloudDirectory
|
|
1740
1911
|
end
|
1741
1912
|
|
1742
1913
|
# @!attribute [rw] schema_arn
|
1743
|
-
#
|
1914
|
+
# The input ARN that is returned as part of the response. For more
|
1744
1915
|
# information, see arns.
|
1745
1916
|
# @return [String]
|
1746
1917
|
#
|
@@ -1751,6 +1922,35 @@ module Aws::CloudDirectory
|
|
1751
1922
|
include Aws::Structure
|
1752
1923
|
end
|
1753
1924
|
|
1925
|
+
# @note When making an API call, you may pass DeleteTypedLinkFacetRequest
|
1926
|
+
# data as a hash:
|
1927
|
+
#
|
1928
|
+
# {
|
1929
|
+
# schema_arn: "Arn", # required
|
1930
|
+
# name: "TypedLinkName", # required
|
1931
|
+
# }
|
1932
|
+
#
|
1933
|
+
# @!attribute [rw] schema_arn
|
1934
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
1935
|
+
# For more information, see arns.
|
1936
|
+
# @return [String]
|
1937
|
+
#
|
1938
|
+
# @!attribute [rw] name
|
1939
|
+
# The unique name of the typed link facet.
|
1940
|
+
# @return [String]
|
1941
|
+
#
|
1942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteTypedLinkFacetRequest AWS API Documentation
|
1943
|
+
#
|
1944
|
+
class DeleteTypedLinkFacetRequest < Struct.new(
|
1945
|
+
:schema_arn,
|
1946
|
+
:name)
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteTypedLinkFacetResponse AWS API Documentation
|
1951
|
+
#
|
1952
|
+
class DeleteTypedLinkFacetResponse < Aws::EmptyStructure; end
|
1953
|
+
|
1754
1954
|
# @note When making an API call, you may pass DetachFromIndexRequest
|
1755
1955
|
# data as a hash:
|
1756
1956
|
#
|
@@ -1765,7 +1965,8 @@ module Aws::CloudDirectory
|
|
1765
1965
|
# }
|
1766
1966
|
#
|
1767
1967
|
# @!attribute [rw] directory_arn
|
1768
|
-
# The ARN of the directory the index and object
|
1968
|
+
# The Amazon Resource Name (ARN) of the directory the index and object
|
1969
|
+
# exist in.
|
1769
1970
|
# @return [String]
|
1770
1971
|
#
|
1771
1972
|
# @!attribute [rw] index_reference
|
@@ -1809,17 +2010,17 @@ module Aws::CloudDirectory
|
|
1809
2010
|
# }
|
1810
2011
|
#
|
1811
2012
|
# @!attribute [rw] directory_arn
|
1812
|
-
# ARN associated with the Directory
|
1813
|
-
# information, see arns.
|
2013
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
2014
|
+
# where objects reside. For more information, see arns.
|
1814
2015
|
# @return [String]
|
1815
2016
|
#
|
1816
2017
|
# @!attribute [rw] parent_reference
|
1817
|
-
#
|
1818
|
-
# is detached.
|
2018
|
+
# The parent reference from which the object with the specified link
|
2019
|
+
# name is detached.
|
1819
2020
|
# @return [Types::ObjectReference]
|
1820
2021
|
#
|
1821
2022
|
# @!attribute [rw] link_name
|
1822
|
-
#
|
2023
|
+
# The link name associated with the object that needs to be detached.
|
1823
2024
|
# @return [String]
|
1824
2025
|
#
|
1825
2026
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObjectRequest AWS API Documentation
|
@@ -1856,8 +2057,8 @@ module Aws::CloudDirectory
|
|
1856
2057
|
# }
|
1857
2058
|
#
|
1858
2059
|
# @!attribute [rw] directory_arn
|
1859
|
-
# ARN associated with the Directory
|
1860
|
-
# more information, see arns.
|
2060
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
2061
|
+
# where both objects reside. For more information, see arns.
|
1861
2062
|
# @return [String]
|
1862
2063
|
#
|
1863
2064
|
# @!attribute [rw] policy_reference
|
@@ -1882,6 +2083,54 @@ module Aws::CloudDirectory
|
|
1882
2083
|
#
|
1883
2084
|
class DetachPolicyResponse < Aws::EmptyStructure; end
|
1884
2085
|
|
2086
|
+
# @note When making an API call, you may pass DetachTypedLinkRequest
|
2087
|
+
# data as a hash:
|
2088
|
+
#
|
2089
|
+
# {
|
2090
|
+
# directory_arn: "Arn", # required
|
2091
|
+
# typed_link_specifier: { # required
|
2092
|
+
# typed_link_facet: { # required
|
2093
|
+
# schema_arn: "Arn", # required
|
2094
|
+
# typed_link_name: "TypedLinkName", # required
|
2095
|
+
# },
|
2096
|
+
# source_object_reference: { # required
|
2097
|
+
# selector: "SelectorObjectReference",
|
2098
|
+
# },
|
2099
|
+
# target_object_reference: { # required
|
2100
|
+
# selector: "SelectorObjectReference",
|
2101
|
+
# },
|
2102
|
+
# identity_attribute_values: [ # required
|
2103
|
+
# {
|
2104
|
+
# attribute_name: "AttributeName", # required
|
2105
|
+
# value: { # required
|
2106
|
+
# string_value: "StringAttributeValue",
|
2107
|
+
# binary_value: "data",
|
2108
|
+
# boolean_value: false,
|
2109
|
+
# number_value: "NumberAttributeValue",
|
2110
|
+
# datetime_value: Time.now,
|
2111
|
+
# },
|
2112
|
+
# },
|
2113
|
+
# ],
|
2114
|
+
# },
|
2115
|
+
# }
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] directory_arn
|
2118
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
2119
|
+
# detach the typed link.
|
2120
|
+
# @return [String]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] typed_link_specifier
|
2123
|
+
# Used to accept a typed link specifier as input.
|
2124
|
+
# @return [Types::TypedLinkSpecifier]
|
2125
|
+
#
|
2126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachTypedLinkRequest AWS API Documentation
|
2127
|
+
#
|
2128
|
+
class DetachTypedLinkRequest < Struct.new(
|
2129
|
+
:directory_arn,
|
2130
|
+
:typed_link_specifier)
|
2131
|
+
include Aws::Structure
|
2132
|
+
end
|
2133
|
+
|
1885
2134
|
# Directory structure that includes the directory name and directory
|
1886
2135
|
# ARN.
|
1887
2136
|
#
|
@@ -1890,7 +2139,8 @@ module Aws::CloudDirectory
|
|
1890
2139
|
# @return [String]
|
1891
2140
|
#
|
1892
2141
|
# @!attribute [rw] directory_arn
|
1893
|
-
#
|
2142
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
2143
|
+
# directory. For more information, see arns.
|
1894
2144
|
# @return [String]
|
1895
2145
|
#
|
1896
2146
|
# @!attribute [rw] state
|
@@ -1978,7 +2228,7 @@ module Aws::CloudDirectory
|
|
1978
2228
|
# @return [String]
|
1979
2229
|
#
|
1980
2230
|
# @!attribute [rw] object_type
|
1981
|
-
#
|
2231
|
+
# The object type that is associated with the facet. See
|
1982
2232
|
# CreateFacetRequest$ObjectType for more details.
|
1983
2233
|
# @return [String]
|
1984
2234
|
#
|
@@ -1990,7 +2240,7 @@ module Aws::CloudDirectory
|
|
1990
2240
|
include Aws::Structure
|
1991
2241
|
end
|
1992
2242
|
|
1993
|
-
#
|
2243
|
+
# An attribute that is associated with the Facet.
|
1994
2244
|
#
|
1995
2245
|
# @note When making an API call, you may pass FacetAttribute
|
1996
2246
|
# data as a hash:
|
@@ -2038,8 +2288,8 @@ module Aws::CloudDirectory
|
|
2038
2288
|
# @return [Types::FacetAttributeDefinition]
|
2039
2289
|
#
|
2040
2290
|
# @!attribute [rw] attribute_reference
|
2041
|
-
#
|
2042
|
-
# References][1] for more information.
|
2291
|
+
# An attribute reference that is associated with the attribute. See
|
2292
|
+
# [Attribute References][1] for more information.
|
2043
2293
|
#
|
2044
2294
|
#
|
2045
2295
|
#
|
@@ -2116,8 +2366,8 @@ module Aws::CloudDirectory
|
|
2116
2366
|
include Aws::Structure
|
2117
2367
|
end
|
2118
2368
|
|
2119
|
-
#
|
2120
|
-
#
|
2369
|
+
# The facet attribute reference that specifies the attribute definition
|
2370
|
+
# that contains the attribute facet name and attribute name.
|
2121
2371
|
#
|
2122
2372
|
# @note When making an API call, you may pass FacetAttributeReference
|
2123
2373
|
# data as a hash:
|
@@ -2128,8 +2378,8 @@ module Aws::CloudDirectory
|
|
2128
2378
|
# }
|
2129
2379
|
#
|
2130
2380
|
# @!attribute [rw] target_facet_name
|
2131
|
-
#
|
2132
|
-
# [Attribute References][1] for more information.
|
2381
|
+
# The target facet name that is associated with the facet reference.
|
2382
|
+
# See [Attribute References][1] for more information.
|
2133
2383
|
#
|
2134
2384
|
#
|
2135
2385
|
#
|
@@ -2137,8 +2387,8 @@ module Aws::CloudDirectory
|
|
2137
2387
|
# @return [String]
|
2138
2388
|
#
|
2139
2389
|
# @!attribute [rw] target_attribute_name
|
2140
|
-
#
|
2141
|
-
# [Attribute References][1] for more information.
|
2390
|
+
# The target attribute name that is associated with the facet
|
2391
|
+
# reference. See [Attribute References][1] for more information.
|
2142
2392
|
#
|
2143
2393
|
#
|
2144
2394
|
#
|
@@ -2243,7 +2493,8 @@ module Aws::CloudDirectory
|
|
2243
2493
|
# }
|
2244
2494
|
#
|
2245
2495
|
# @!attribute [rw] schema_arn
|
2246
|
-
# ARN associated with the Facet.
|
2496
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet.
|
2497
|
+
# For more information, see arns.
|
2247
2498
|
# @return [String]
|
2248
2499
|
#
|
2249
2500
|
# @!attribute [rw] name
|
@@ -2259,7 +2510,7 @@ module Aws::CloudDirectory
|
|
2259
2510
|
end
|
2260
2511
|
|
2261
2512
|
# @!attribute [rw] facet
|
2262
|
-
# Facet structure associated with the facet.
|
2513
|
+
# The Facet structure that is associated with the facet.
|
2263
2514
|
# @return [Types::Facet]
|
2264
2515
|
#
|
2265
2516
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacetResponse AWS API Documentation
|
@@ -2351,6 +2602,55 @@ module Aws::CloudDirectory
|
|
2351
2602
|
include Aws::Structure
|
2352
2603
|
end
|
2353
2604
|
|
2605
|
+
# @note When making an API call, you may pass GetTypedLinkFacetInformationRequest
|
2606
|
+
# data as a hash:
|
2607
|
+
#
|
2608
|
+
# {
|
2609
|
+
# schema_arn: "Arn", # required
|
2610
|
+
# name: "TypedLinkName", # required
|
2611
|
+
# }
|
2612
|
+
#
|
2613
|
+
# @!attribute [rw] schema_arn
|
2614
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
2615
|
+
# For more information, see arns.
|
2616
|
+
# @return [String]
|
2617
|
+
#
|
2618
|
+
# @!attribute [rw] name
|
2619
|
+
# The unique name of the typed link facet.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetTypedLinkFacetInformationRequest AWS API Documentation
|
2623
|
+
#
|
2624
|
+
class GetTypedLinkFacetInformationRequest < Struct.new(
|
2625
|
+
:schema_arn,
|
2626
|
+
:name)
|
2627
|
+
include Aws::Structure
|
2628
|
+
end
|
2629
|
+
|
2630
|
+
# @!attribute [rw] identity_attribute_order
|
2631
|
+
# The order of identity attributes for the facet, from most
|
2632
|
+
# significant to least significant. The ability to filter typed links
|
2633
|
+
# considers the order that the attributes are defined on the typed
|
2634
|
+
# link facet. When providing ranges to typed link selection, any
|
2635
|
+
# inexact ranges must be specified at the end. Any attributes that do
|
2636
|
+
# not have a range specified are presumed to match the entire range.
|
2637
|
+
# Filters are interpreted in the order of the attributes on the typed
|
2638
|
+
# link facet, not the order in which they are supplied to any API
|
2639
|
+
# calls. For more information about identity attributes, see [Typed
|
2640
|
+
# link][1].
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
#
|
2644
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
2645
|
+
# @return [Array<String>]
|
2646
|
+
#
|
2647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetTypedLinkFacetInformationResponse AWS API Documentation
|
2648
|
+
#
|
2649
|
+
class GetTypedLinkFacetInformationResponse < Struct.new(
|
2650
|
+
:identity_attribute_order)
|
2651
|
+
include Aws::Structure
|
2652
|
+
end
|
2653
|
+
|
2354
2654
|
# Represents an index and an attached object.
|
2355
2655
|
#
|
2356
2656
|
# @!attribute [rw] indexed_attributes
|
@@ -2547,8 +2847,8 @@ module Aws::CloudDirectory
|
|
2547
2847
|
end
|
2548
2848
|
|
2549
2849
|
# @!attribute [rw] directories
|
2550
|
-
# Lists all directories associated with your account in
|
2551
|
-
# fashion.
|
2850
|
+
# Lists all directories that are associated with your account in
|
2851
|
+
# pagination fashion.
|
2552
2852
|
# @return [Array<Types::Directory>]
|
2553
2853
|
#
|
2554
2854
|
# @!attribute [rw] next_token
|
@@ -2625,7 +2925,7 @@ module Aws::CloudDirectory
|
|
2625
2925
|
# }
|
2626
2926
|
#
|
2627
2927
|
# @!attribute [rw] schema_arn
|
2628
|
-
# The ARN to retrieve facet names from.
|
2928
|
+
# The Amazon Resource Name (ARN) to retrieve facet names from.
|
2629
2929
|
# @return [String]
|
2630
2930
|
#
|
2631
2931
|
# @!attribute [rw] next_token
|
@@ -2633,7 +2933,7 @@ module Aws::CloudDirectory
|
|
2633
2933
|
# @return [String]
|
2634
2934
|
#
|
2635
2935
|
# @!attribute [rw] max_results
|
2636
|
-
# The maximum number of results to retrieve
|
2936
|
+
# The maximum number of results to retrieve.
|
2637
2937
|
# @return [Integer]
|
2638
2938
|
#
|
2639
2939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNamesRequest AWS API Documentation
|
@@ -2661,19 +2961,18 @@ module Aws::CloudDirectory
|
|
2661
2961
|
include Aws::Structure
|
2662
2962
|
end
|
2663
2963
|
|
2664
|
-
# @note When making an API call, you may pass
|
2964
|
+
# @note When making an API call, you may pass ListIncomingTypedLinksRequest
|
2665
2965
|
# data as a hash:
|
2666
2966
|
#
|
2667
2967
|
# {
|
2668
2968
|
# directory_arn: "Arn", # required
|
2669
|
-
#
|
2969
|
+
# object_reference: { # required
|
2970
|
+
# selector: "SelectorObjectReference",
|
2971
|
+
# },
|
2972
|
+
# filter_attribute_ranges: [
|
2670
2973
|
# {
|
2671
|
-
#
|
2672
|
-
#
|
2673
|
-
# facet_name: "FacetName", # required
|
2674
|
-
# name: "AttributeName", # required
|
2675
|
-
# },
|
2676
|
-
# range: {
|
2974
|
+
# attribute_name: "AttributeName",
|
2975
|
+
# range: { # required
|
2677
2976
|
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
2678
2977
|
# start_value: {
|
2679
2978
|
# string_value: "StringAttributeValue",
|
@@ -2693,29 +2992,134 @@ module Aws::CloudDirectory
|
|
2693
2992
|
# },
|
2694
2993
|
# },
|
2695
2994
|
# ],
|
2696
|
-
#
|
2697
|
-
#
|
2995
|
+
# filter_typed_link: {
|
2996
|
+
# schema_arn: "Arn", # required
|
2997
|
+
# typed_link_name: "TypedLinkName", # required
|
2698
2998
|
# },
|
2699
|
-
# max_results: 1,
|
2700
2999
|
# next_token: "NextToken",
|
3000
|
+
# max_results: 1,
|
2701
3001
|
# consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
|
2702
3002
|
# }
|
2703
3003
|
#
|
2704
3004
|
# @!attribute [rw] directory_arn
|
2705
|
-
# The ARN of the directory
|
3005
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
3006
|
+
# list the typed links.
|
2706
3007
|
# @return [String]
|
2707
3008
|
#
|
2708
|
-
# @!attribute [rw]
|
2709
|
-
#
|
2710
|
-
#
|
2711
|
-
#
|
2712
|
-
# @!attribute [rw] index_reference
|
2713
|
-
# The reference to the index to list.
|
3009
|
+
# @!attribute [rw] object_reference
|
3010
|
+
# Reference that identifies the object whose attributes will be
|
3011
|
+
# listed.
|
2714
3012
|
# @return [Types::ObjectReference]
|
2715
3013
|
#
|
2716
|
-
# @!attribute [rw]
|
2717
|
-
#
|
2718
|
-
#
|
3014
|
+
# @!attribute [rw] filter_attribute_ranges
|
3015
|
+
# Provides range filters for multiple attributes. When providing
|
3016
|
+
# ranges to typed link selection, any inexact ranges must be specified
|
3017
|
+
# at the end. Any attributes that do not have a range specified are
|
3018
|
+
# presumed to match the entire range.
|
3019
|
+
# @return [Array<Types::TypedLinkAttributeRange>]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] filter_typed_link
|
3022
|
+
# Filters are interpreted in the order of the attributes on the typed
|
3023
|
+
# link facet, not the order in which they are supplied to any API
|
3024
|
+
# calls.
|
3025
|
+
# @return [Types::TypedLinkSchemaAndFacetName]
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] next_token
|
3028
|
+
# The pagination token.
|
3029
|
+
# @return [String]
|
3030
|
+
#
|
3031
|
+
# @!attribute [rw] max_results
|
3032
|
+
# The maximum number of results to retrieve.
|
3033
|
+
# @return [Integer]
|
3034
|
+
#
|
3035
|
+
# @!attribute [rw] consistency_level
|
3036
|
+
# The consistency level to execute the request at.
|
3037
|
+
# @return [String]
|
3038
|
+
#
|
3039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIncomingTypedLinksRequest AWS API Documentation
|
3040
|
+
#
|
3041
|
+
class ListIncomingTypedLinksRequest < Struct.new(
|
3042
|
+
:directory_arn,
|
3043
|
+
:object_reference,
|
3044
|
+
:filter_attribute_ranges,
|
3045
|
+
:filter_typed_link,
|
3046
|
+
:next_token,
|
3047
|
+
:max_results,
|
3048
|
+
:consistency_level)
|
3049
|
+
include Aws::Structure
|
3050
|
+
end
|
3051
|
+
|
3052
|
+
# @!attribute [rw] link_specifiers
|
3053
|
+
# Returns one or more typed link specifiers as output.
|
3054
|
+
# @return [Array<Types::TypedLinkSpecifier>]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] next_token
|
3057
|
+
# The pagination token.
|
3058
|
+
# @return [String]
|
3059
|
+
#
|
3060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIncomingTypedLinksResponse AWS API Documentation
|
3061
|
+
#
|
3062
|
+
class ListIncomingTypedLinksResponse < Struct.new(
|
3063
|
+
:link_specifiers,
|
3064
|
+
:next_token)
|
3065
|
+
include Aws::Structure
|
3066
|
+
end
|
3067
|
+
|
3068
|
+
# @note When making an API call, you may pass ListIndexRequest
|
3069
|
+
# data as a hash:
|
3070
|
+
#
|
3071
|
+
# {
|
3072
|
+
# directory_arn: "Arn", # required
|
3073
|
+
# ranges_on_indexed_values: [
|
3074
|
+
# {
|
3075
|
+
# attribute_key: {
|
3076
|
+
# schema_arn: "Arn", # required
|
3077
|
+
# facet_name: "FacetName", # required
|
3078
|
+
# name: "AttributeName", # required
|
3079
|
+
# },
|
3080
|
+
# range: {
|
3081
|
+
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
3082
|
+
# start_value: {
|
3083
|
+
# string_value: "StringAttributeValue",
|
3084
|
+
# binary_value: "data",
|
3085
|
+
# boolean_value: false,
|
3086
|
+
# number_value: "NumberAttributeValue",
|
3087
|
+
# datetime_value: Time.now,
|
3088
|
+
# },
|
3089
|
+
# end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
3090
|
+
# end_value: {
|
3091
|
+
# string_value: "StringAttributeValue",
|
3092
|
+
# binary_value: "data",
|
3093
|
+
# boolean_value: false,
|
3094
|
+
# number_value: "NumberAttributeValue",
|
3095
|
+
# datetime_value: Time.now,
|
3096
|
+
# },
|
3097
|
+
# },
|
3098
|
+
# },
|
3099
|
+
# ],
|
3100
|
+
# index_reference: { # required
|
3101
|
+
# selector: "SelectorObjectReference",
|
3102
|
+
# },
|
3103
|
+
# max_results: 1,
|
3104
|
+
# next_token: "NextToken",
|
3105
|
+
# consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
|
3106
|
+
# }
|
3107
|
+
#
|
3108
|
+
# @!attribute [rw] directory_arn
|
3109
|
+
# The ARN of the directory that the index exists in.
|
3110
|
+
# @return [String]
|
3111
|
+
#
|
3112
|
+
# @!attribute [rw] ranges_on_indexed_values
|
3113
|
+
# Specifies the ranges of indexed values that you want to query.
|
3114
|
+
# @return [Array<Types::ObjectAttributeRange>]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] index_reference
|
3117
|
+
# The reference to the index to list.
|
3118
|
+
# @return [Types::ObjectReference]
|
3119
|
+
#
|
3120
|
+
# @!attribute [rw] max_results
|
3121
|
+
# The maximum number of results to retrieve from the index.
|
3122
|
+
# @return [Integer]
|
2719
3123
|
#
|
2720
3124
|
# @!attribute [rw] next_token
|
2721
3125
|
# The pagination token.
|
@@ -2771,12 +3175,12 @@ module Aws::CloudDirectory
|
|
2771
3175
|
# }
|
2772
3176
|
#
|
2773
3177
|
# @!attribute [rw] directory_arn
|
2774
|
-
#
|
2775
|
-
# information, see arns.
|
3178
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
3179
|
+
# where the object resides. For more information, see arns.
|
2776
3180
|
# @return [String]
|
2777
3181
|
#
|
2778
3182
|
# @!attribute [rw] object_reference
|
2779
|
-
#
|
3183
|
+
# The reference that identifies the object whose attributes will be
|
2780
3184
|
# listed.
|
2781
3185
|
# @return [Types::ObjectReference]
|
2782
3186
|
#
|
@@ -2785,8 +3189,8 @@ module Aws::CloudDirectory
|
|
2785
3189
|
# @return [String]
|
2786
3190
|
#
|
2787
3191
|
# @!attribute [rw] max_results
|
2788
|
-
#
|
2789
|
-
# approximate number.
|
3192
|
+
# The maximum number of items to be retrieved in a single call. This
|
3193
|
+
# is an approximate number.
|
2790
3194
|
# @return [Integer]
|
2791
3195
|
#
|
2792
3196
|
# @!attribute [rw] consistency_level
|
@@ -2796,8 +3200,8 @@ module Aws::CloudDirectory
|
|
2796
3200
|
# @return [String]
|
2797
3201
|
#
|
2798
3202
|
# @!attribute [rw] facet_filter
|
2799
|
-
# Used to filter the list of object attributes
|
2800
|
-
# certain facet.
|
3203
|
+
# Used to filter the list of object attributes that are associated
|
3204
|
+
# with a certain facet.
|
2801
3205
|
# @return [Types::SchemaFacet]
|
2802
3206
|
#
|
2803
3207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributesRequest AWS API Documentation
|
@@ -2813,8 +3217,8 @@ module Aws::CloudDirectory
|
|
2813
3217
|
end
|
2814
3218
|
|
2815
3219
|
# @!attribute [rw] attributes
|
2816
|
-
# Attributes map associated with the object. AttributeArn is
|
2817
|
-
# and attribute value is the value.
|
3220
|
+
# Attributes map that is associated with the object. `AttributeArn` is
|
3221
|
+
# the key, and attribute value is the value.
|
2818
3222
|
# @return [Array<Types::AttributeKeyAndValue>]
|
2819
3223
|
#
|
2820
3224
|
# @!attribute [rw] next_token
|
@@ -2843,12 +3247,12 @@ module Aws::CloudDirectory
|
|
2843
3247
|
# }
|
2844
3248
|
#
|
2845
3249
|
# @!attribute [rw] directory_arn
|
2846
|
-
#
|
2847
|
-
# information, see arns.
|
3250
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
3251
|
+
# where the object resides. For more information, see arns.
|
2848
3252
|
# @return [String]
|
2849
3253
|
#
|
2850
3254
|
# @!attribute [rw] object_reference
|
2851
|
-
#
|
3255
|
+
# The reference that identifies the object for which child objects are
|
2852
3256
|
# being listed.
|
2853
3257
|
# @return [Types::ObjectReference]
|
2854
3258
|
#
|
@@ -2857,8 +3261,8 @@ module Aws::CloudDirectory
|
|
2857
3261
|
# @return [String]
|
2858
3262
|
#
|
2859
3263
|
# @!attribute [rw] max_results
|
2860
|
-
#
|
2861
|
-
# approximate number.
|
3264
|
+
# The maximum number of items to be retrieved in a single call. This
|
3265
|
+
# is an approximate number.
|
2862
3266
|
# @return [Integer]
|
2863
3267
|
#
|
2864
3268
|
# @!attribute [rw] consistency_level
|
@@ -2879,7 +3283,7 @@ module Aws::CloudDirectory
|
|
2879
3283
|
end
|
2880
3284
|
|
2881
3285
|
# @!attribute [rw] children
|
2882
|
-
# Children structure, which is a map with key as the LinkName and
|
3286
|
+
# Children structure, which is a map with key as the `LinkName` and
|
2883
3287
|
# `ObjectIdentifier` as the value.
|
2884
3288
|
# @return [Hash<String,String>]
|
2885
3289
|
#
|
@@ -2912,7 +3316,8 @@ module Aws::CloudDirectory
|
|
2912
3316
|
# @return [String]
|
2913
3317
|
#
|
2914
3318
|
# @!attribute [rw] object_reference
|
2915
|
-
#
|
3319
|
+
# The reference that identifies the object whose parent paths are
|
3320
|
+
# listed.
|
2916
3321
|
# @return [Types::ObjectReference]
|
2917
3322
|
#
|
2918
3323
|
# @!attribute [rw] next_token
|
@@ -2920,8 +3325,8 @@ module Aws::CloudDirectory
|
|
2920
3325
|
# @return [String]
|
2921
3326
|
#
|
2922
3327
|
# @!attribute [rw] max_results
|
2923
|
-
#
|
2924
|
-
# approximate number.
|
3328
|
+
# The maximum number of items to be retrieved in a single call. This
|
3329
|
+
# is an approximate number.
|
2925
3330
|
# @return [Integer]
|
2926
3331
|
#
|
2927
3332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentPathsRequest AWS API Documentation
|
@@ -2935,8 +3340,8 @@ module Aws::CloudDirectory
|
|
2935
3340
|
end
|
2936
3341
|
|
2937
3342
|
# @!attribute [rw] path_to_object_identifiers_list
|
2938
|
-
# Returns the path to the `ObjectIdentifiers` associated with
|
2939
|
-
# directory.
|
3343
|
+
# Returns the path to the `ObjectIdentifiers` that are associated with
|
3344
|
+
# the directory.
|
2940
3345
|
# @return [Array<Types::PathToObjectIdentifiers>]
|
2941
3346
|
#
|
2942
3347
|
# @!attribute [rw] next_token
|
@@ -2965,13 +3370,13 @@ module Aws::CloudDirectory
|
|
2965
3370
|
# }
|
2966
3371
|
#
|
2967
3372
|
# @!attribute [rw] directory_arn
|
2968
|
-
#
|
2969
|
-
# information, see arns.
|
3373
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
3374
|
+
# where the object resides. For more information, see arns.
|
2970
3375
|
# @return [String]
|
2971
3376
|
#
|
2972
3377
|
# @!attribute [rw] object_reference
|
2973
|
-
#
|
2974
|
-
# being listed.
|
3378
|
+
# The reference that identifies the object for which parent objects
|
3379
|
+
# are being listed.
|
2975
3380
|
# @return [Types::ObjectReference]
|
2976
3381
|
#
|
2977
3382
|
# @!attribute [rw] next_token
|
@@ -2979,8 +3384,8 @@ module Aws::CloudDirectory
|
|
2979
3384
|
# @return [String]
|
2980
3385
|
#
|
2981
3386
|
# @!attribute [rw] max_results
|
2982
|
-
#
|
2983
|
-
# approximate number.
|
3387
|
+
# The maximum number of items to be retrieved in a single call. This
|
3388
|
+
# is an approximate number.
|
2984
3389
|
# @return [Integer]
|
2985
3390
|
#
|
2986
3391
|
# @!attribute [rw] consistency_level
|
@@ -3001,8 +3406,8 @@ module Aws::CloudDirectory
|
|
3001
3406
|
end
|
3002
3407
|
|
3003
3408
|
# @!attribute [rw] parents
|
3004
|
-
#
|
3005
|
-
# and LinkName as the value.
|
3409
|
+
# The parent structure, which is a map with key as the
|
3410
|
+
# `ObjectIdentifier` and LinkName as the value.
|
3006
3411
|
# @return [Hash<String,String>]
|
3007
3412
|
#
|
3008
3413
|
# @!attribute [rw] next_token
|
@@ -3031,8 +3436,8 @@ module Aws::CloudDirectory
|
|
3031
3436
|
# }
|
3032
3437
|
#
|
3033
3438
|
# @!attribute [rw] directory_arn
|
3034
|
-
# ARN associated with the Directory
|
3035
|
-
# information, see arns.
|
3439
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
3440
|
+
# where objects reside. For more information, see arns.
|
3036
3441
|
# @return [String]
|
3037
3442
|
#
|
3038
3443
|
# @!attribute [rw] object_reference
|
@@ -3045,8 +3450,8 @@ module Aws::CloudDirectory
|
|
3045
3450
|
# @return [String]
|
3046
3451
|
#
|
3047
3452
|
# @!attribute [rw] max_results
|
3048
|
-
#
|
3049
|
-
# approximate number.
|
3453
|
+
# The maximum number of items to be retrieved in a single call. This
|
3454
|
+
# is an approximate number.
|
3050
3455
|
# @return [Integer]
|
3051
3456
|
#
|
3052
3457
|
# @!attribute [rw] consistency_level
|
@@ -3067,7 +3472,8 @@ module Aws::CloudDirectory
|
|
3067
3472
|
end
|
3068
3473
|
|
3069
3474
|
# @!attribute [rw] attached_policy_ids
|
3070
|
-
#
|
3475
|
+
# A list of policy `ObjectIdentifiers`, that are attached to the
|
3476
|
+
# object.
|
3071
3477
|
# @return [Array<String>]
|
3072
3478
|
#
|
3073
3479
|
# @!attribute [rw] next_token
|
@@ -3082,6 +3488,110 @@ module Aws::CloudDirectory
|
|
3082
3488
|
include Aws::Structure
|
3083
3489
|
end
|
3084
3490
|
|
3491
|
+
# @note When making an API call, you may pass ListOutgoingTypedLinksRequest
|
3492
|
+
# data as a hash:
|
3493
|
+
#
|
3494
|
+
# {
|
3495
|
+
# directory_arn: "Arn", # required
|
3496
|
+
# object_reference: { # required
|
3497
|
+
# selector: "SelectorObjectReference",
|
3498
|
+
# },
|
3499
|
+
# filter_attribute_ranges: [
|
3500
|
+
# {
|
3501
|
+
# attribute_name: "AttributeName",
|
3502
|
+
# range: { # required
|
3503
|
+
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
3504
|
+
# start_value: {
|
3505
|
+
# string_value: "StringAttributeValue",
|
3506
|
+
# binary_value: "data",
|
3507
|
+
# boolean_value: false,
|
3508
|
+
# number_value: "NumberAttributeValue",
|
3509
|
+
# datetime_value: Time.now,
|
3510
|
+
# },
|
3511
|
+
# end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
3512
|
+
# end_value: {
|
3513
|
+
# string_value: "StringAttributeValue",
|
3514
|
+
# binary_value: "data",
|
3515
|
+
# boolean_value: false,
|
3516
|
+
# number_value: "NumberAttributeValue",
|
3517
|
+
# datetime_value: Time.now,
|
3518
|
+
# },
|
3519
|
+
# },
|
3520
|
+
# },
|
3521
|
+
# ],
|
3522
|
+
# filter_typed_link: {
|
3523
|
+
# schema_arn: "Arn", # required
|
3524
|
+
# typed_link_name: "TypedLinkName", # required
|
3525
|
+
# },
|
3526
|
+
# next_token: "NextToken",
|
3527
|
+
# max_results: 1,
|
3528
|
+
# consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
|
3529
|
+
# }
|
3530
|
+
#
|
3531
|
+
# @!attribute [rw] directory_arn
|
3532
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
3533
|
+
# list the typed links.
|
3534
|
+
# @return [String]
|
3535
|
+
#
|
3536
|
+
# @!attribute [rw] object_reference
|
3537
|
+
# A reference that identifies the object whose attributes will be
|
3538
|
+
# listed.
|
3539
|
+
# @return [Types::ObjectReference]
|
3540
|
+
#
|
3541
|
+
# @!attribute [rw] filter_attribute_ranges
|
3542
|
+
# Provides range filters for multiple attributes. When providing
|
3543
|
+
# ranges to typed link selection, any inexact ranges must be specified
|
3544
|
+
# at the end. Any attributes that do not have a range specified are
|
3545
|
+
# presumed to match the entire range.
|
3546
|
+
# @return [Array<Types::TypedLinkAttributeRange>]
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] filter_typed_link
|
3549
|
+
# Filters are interpreted in the order of the attributes defined on
|
3550
|
+
# the typed link facet, not the order they are supplied to any API
|
3551
|
+
# calls.
|
3552
|
+
# @return [Types::TypedLinkSchemaAndFacetName]
|
3553
|
+
#
|
3554
|
+
# @!attribute [rw] next_token
|
3555
|
+
# The pagination token.
|
3556
|
+
# @return [String]
|
3557
|
+
#
|
3558
|
+
# @!attribute [rw] max_results
|
3559
|
+
# The maximum number of results to retrieve.
|
3560
|
+
# @return [Integer]
|
3561
|
+
#
|
3562
|
+
# @!attribute [rw] consistency_level
|
3563
|
+
# The consistency level to execute the request at.
|
3564
|
+
# @return [String]
|
3565
|
+
#
|
3566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListOutgoingTypedLinksRequest AWS API Documentation
|
3567
|
+
#
|
3568
|
+
class ListOutgoingTypedLinksRequest < Struct.new(
|
3569
|
+
:directory_arn,
|
3570
|
+
:object_reference,
|
3571
|
+
:filter_attribute_ranges,
|
3572
|
+
:filter_typed_link,
|
3573
|
+
:next_token,
|
3574
|
+
:max_results,
|
3575
|
+
:consistency_level)
|
3576
|
+
include Aws::Structure
|
3577
|
+
end
|
3578
|
+
|
3579
|
+
# @!attribute [rw] typed_link_specifiers
|
3580
|
+
# Returns a typed link specifier as output.
|
3581
|
+
# @return [Array<Types::TypedLinkSpecifier>]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] next_token
|
3584
|
+
# The pagination token.
|
3585
|
+
# @return [String]
|
3586
|
+
#
|
3587
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListOutgoingTypedLinksResponse AWS API Documentation
|
3588
|
+
#
|
3589
|
+
class ListOutgoingTypedLinksResponse < Struct.new(
|
3590
|
+
:typed_link_specifiers,
|
3591
|
+
:next_token)
|
3592
|
+
include Aws::Structure
|
3593
|
+
end
|
3594
|
+
|
3085
3595
|
# @note When making an API call, you may pass ListPolicyAttachmentsRequest
|
3086
3596
|
# data as a hash:
|
3087
3597
|
#
|
@@ -3096,12 +3606,12 @@ module Aws::CloudDirectory
|
|
3096
3606
|
# }
|
3097
3607
|
#
|
3098
3608
|
# @!attribute [rw] directory_arn
|
3099
|
-
# ARN associated with the Directory
|
3100
|
-
# information, see arns.
|
3609
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
3610
|
+
# where objects reside. For more information, see arns.
|
3101
3611
|
# @return [String]
|
3102
3612
|
#
|
3103
3613
|
# @!attribute [rw] policy_reference
|
3104
|
-
#
|
3614
|
+
# The reference that identifies the policy object.
|
3105
3615
|
# @return [Types::ObjectReference]
|
3106
3616
|
#
|
3107
3617
|
# @!attribute [rw] next_token
|
@@ -3109,8 +3619,8 @@ module Aws::CloudDirectory
|
|
3109
3619
|
# @return [String]
|
3110
3620
|
#
|
3111
3621
|
# @!attribute [rw] max_results
|
3112
|
-
#
|
3113
|
-
# approximate number.
|
3622
|
+
# The maximum number of items to be retrieved in a single call. This
|
3623
|
+
# is an approximate number.
|
3114
3624
|
# @return [Integer]
|
3115
3625
|
#
|
3116
3626
|
# @!attribute [rw] consistency_level
|
@@ -3131,7 +3641,7 @@ module Aws::CloudDirectory
|
|
3131
3641
|
end
|
3132
3642
|
|
3133
3643
|
# @!attribute [rw] object_identifiers
|
3134
|
-
#
|
3644
|
+
# A list of `ObjectIdentifiers` to which the policy is attached.
|
3135
3645
|
# @return [Array<String>]
|
3136
3646
|
#
|
3137
3647
|
# @!attribute [rw] next_token
|
@@ -3196,7 +3706,8 @@ module Aws::CloudDirectory
|
|
3196
3706
|
# }
|
3197
3707
|
#
|
3198
3708
|
# @!attribute [rw] resource_arn
|
3199
|
-
# ARN of the resource. Tagging is only
|
3709
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
3710
|
+
# supported for directories.
|
3200
3711
|
# @return [String]
|
3201
3712
|
#
|
3202
3713
|
# @!attribute [rw] next_token
|
@@ -3205,9 +3716,9 @@ module Aws::CloudDirectory
|
|
3205
3716
|
# @return [String]
|
3206
3717
|
#
|
3207
3718
|
# @!attribute [rw] max_results
|
3208
|
-
# The MaxResults parameter sets the maximum number of results
|
3209
|
-
# in a single page. This is for future use and is not
|
3210
|
-
# currently.
|
3719
|
+
# The `MaxResults` parameter sets the maximum number of results
|
3720
|
+
# returned in a single page. This is for future use and is not
|
3721
|
+
# supported currently.
|
3211
3722
|
# @return [Integer]
|
3212
3723
|
#
|
3213
3724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResourceRequest AWS API Documentation
|
@@ -3220,7 +3731,7 @@ module Aws::CloudDirectory
|
|
3220
3731
|
end
|
3221
3732
|
|
3222
3733
|
# @!attribute [rw] tags
|
3223
|
-
#
|
3734
|
+
# A list of tag key value pairs that are associated with the response.
|
3224
3735
|
# @return [Array<Types::Tag>]
|
3225
3736
|
#
|
3226
3737
|
# @!attribute [rw] next_token
|
@@ -3236,98 +3747,204 @@ module Aws::CloudDirectory
|
|
3236
3747
|
include Aws::Structure
|
3237
3748
|
end
|
3238
3749
|
|
3239
|
-
# @note When making an API call, you may pass
|
3750
|
+
# @note When making an API call, you may pass ListTypedLinkFacetAttributesRequest
|
3240
3751
|
# data as a hash:
|
3241
3752
|
#
|
3242
3753
|
# {
|
3243
|
-
#
|
3244
|
-
#
|
3245
|
-
# selector: "SelectorObjectReference",
|
3246
|
-
# },
|
3754
|
+
# schema_arn: "Arn", # required
|
3755
|
+
# name: "TypedLinkName", # required
|
3247
3756
|
# next_token: "NextToken",
|
3248
3757
|
# max_results: 1,
|
3249
3758
|
# }
|
3250
3759
|
#
|
3251
|
-
# @!attribute [rw]
|
3252
|
-
#
|
3760
|
+
# @!attribute [rw] schema_arn
|
3761
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
3762
|
+
# For more information, see arns.
|
3253
3763
|
# @return [String]
|
3254
3764
|
#
|
3255
|
-
# @!attribute [rw]
|
3256
|
-
#
|
3257
|
-
#
|
3258
|
-
# @return [Types::ObjectReference]
|
3765
|
+
# @!attribute [rw] name
|
3766
|
+
# The unique name of the typed link facet.
|
3767
|
+
# @return [String]
|
3259
3768
|
#
|
3260
3769
|
# @!attribute [rw] next_token
|
3261
|
-
# The token
|
3770
|
+
# The pagination token.
|
3262
3771
|
# @return [String]
|
3263
3772
|
#
|
3264
3773
|
# @!attribute [rw] max_results
|
3265
|
-
#
|
3266
|
-
# approximate number.
|
3774
|
+
# The maximum number of results to retrieve.
|
3267
3775
|
# @return [Integer]
|
3268
3776
|
#
|
3269
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/
|
3777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetAttributesRequest AWS API Documentation
|
3270
3778
|
#
|
3271
|
-
class
|
3272
|
-
:
|
3273
|
-
:
|
3779
|
+
class ListTypedLinkFacetAttributesRequest < Struct.new(
|
3780
|
+
:schema_arn,
|
3781
|
+
:name,
|
3274
3782
|
:next_token,
|
3275
3783
|
:max_results)
|
3276
3784
|
include Aws::Structure
|
3277
3785
|
end
|
3278
3786
|
|
3279
|
-
# @!attribute [rw]
|
3280
|
-
#
|
3281
|
-
#
|
3282
|
-
# @return [Array<Types::PolicyToPath>]
|
3787
|
+
# @!attribute [rw] attributes
|
3788
|
+
# An ordered set of attributes associate with the typed link.
|
3789
|
+
# @return [Array<Types::TypedLinkAttributeDefinition>]
|
3283
3790
|
#
|
3284
3791
|
# @!attribute [rw] next_token
|
3285
3792
|
# The pagination token.
|
3286
3793
|
# @return [String]
|
3287
3794
|
#
|
3288
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/
|
3795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetAttributesResponse AWS API Documentation
|
3289
3796
|
#
|
3290
|
-
class
|
3291
|
-
:
|
3797
|
+
class ListTypedLinkFacetAttributesResponse < Struct.new(
|
3798
|
+
:attributes,
|
3292
3799
|
:next_token)
|
3293
3800
|
include Aws::Structure
|
3294
3801
|
end
|
3295
3802
|
|
3296
|
-
#
|
3297
|
-
#
|
3298
|
-
# @note When making an API call, you may pass ObjectAttributeAction
|
3803
|
+
# @note When making an API call, you may pass ListTypedLinkFacetNamesRequest
|
3299
3804
|
# data as a hash:
|
3300
3805
|
#
|
3301
3806
|
# {
|
3302
|
-
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
# binary_value: "data",
|
3306
|
-
# boolean_value: false,
|
3307
|
-
# number_value: "NumberAttributeValue",
|
3308
|
-
# datetime_value: Time.now,
|
3309
|
-
# },
|
3807
|
+
# schema_arn: "Arn", # required
|
3808
|
+
# next_token: "NextToken",
|
3809
|
+
# max_results: 1,
|
3310
3810
|
# }
|
3311
3811
|
#
|
3312
|
-
# @!attribute [rw]
|
3313
|
-
#
|
3812
|
+
# @!attribute [rw] schema_arn
|
3813
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
3814
|
+
# For more information, see arns.
|
3314
3815
|
# @return [String]
|
3315
3816
|
#
|
3316
|
-
# @!attribute [rw]
|
3317
|
-
# The
|
3318
|
-
# @return [
|
3817
|
+
# @!attribute [rw] next_token
|
3818
|
+
# The pagination token.
|
3819
|
+
# @return [String]
|
3319
3820
|
#
|
3320
|
-
#
|
3821
|
+
# @!attribute [rw] max_results
|
3822
|
+
# The maximum number of results to retrieve.
|
3823
|
+
# @return [Integer]
|
3321
3824
|
#
|
3322
|
-
|
3323
|
-
|
3324
|
-
|
3825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetNamesRequest AWS API Documentation
|
3826
|
+
#
|
3827
|
+
class ListTypedLinkFacetNamesRequest < Struct.new(
|
3828
|
+
:schema_arn,
|
3829
|
+
:next_token,
|
3830
|
+
:max_results)
|
3325
3831
|
include Aws::Structure
|
3326
3832
|
end
|
3327
3833
|
|
3328
|
-
#
|
3834
|
+
# @!attribute [rw] facet_names
|
3835
|
+
# The names of typed link facets that exist within the schema.
|
3836
|
+
# @return [Array<String>]
|
3329
3837
|
#
|
3330
|
-
#
|
3838
|
+
# @!attribute [rw] next_token
|
3839
|
+
# The pagination token.
|
3840
|
+
# @return [String]
|
3841
|
+
#
|
3842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetNamesResponse AWS API Documentation
|
3843
|
+
#
|
3844
|
+
class ListTypedLinkFacetNamesResponse < Struct.new(
|
3845
|
+
:facet_names,
|
3846
|
+
:next_token)
|
3847
|
+
include Aws::Structure
|
3848
|
+
end
|
3849
|
+
|
3850
|
+
# @note When making an API call, you may pass LookupPolicyRequest
|
3851
|
+
# data as a hash:
|
3852
|
+
#
|
3853
|
+
# {
|
3854
|
+
# directory_arn: "Arn", # required
|
3855
|
+
# object_reference: { # required
|
3856
|
+
# selector: "SelectorObjectReference",
|
3857
|
+
# },
|
3858
|
+
# next_token: "NextToken",
|
3859
|
+
# max_results: 1,
|
3860
|
+
# }
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] directory_arn
|
3863
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
3864
|
+
# Directory. For more information, see arns.
|
3865
|
+
# @return [String]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] object_reference
|
3868
|
+
# Reference that identifies the object whose policies will be looked
|
3869
|
+
# up.
|
3870
|
+
# @return [Types::ObjectReference]
|
3871
|
+
#
|
3872
|
+
# @!attribute [rw] next_token
|
3873
|
+
# The token to request the next page of results.
|
3874
|
+
# @return [String]
|
3875
|
+
#
|
3876
|
+
# @!attribute [rw] max_results
|
3877
|
+
# The maximum number of items to be retrieved in a single call. This
|
3878
|
+
# is an approximate number.
|
3879
|
+
# @return [Integer]
|
3880
|
+
#
|
3881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyRequest AWS API Documentation
|
3882
|
+
#
|
3883
|
+
class LookupPolicyRequest < Struct.new(
|
3884
|
+
:directory_arn,
|
3885
|
+
:object_reference,
|
3886
|
+
:next_token,
|
3887
|
+
:max_results)
|
3888
|
+
include Aws::Structure
|
3889
|
+
end
|
3890
|
+
|
3891
|
+
# @!attribute [rw] policy_to_path_list
|
3892
|
+
# Provides list of path to policies. Policies contain `PolicyId`,
|
3893
|
+
# `ObjectIdentifier`, and `PolicyType`. For more information, see
|
3894
|
+
# [Policies][1].
|
3895
|
+
#
|
3896
|
+
#
|
3897
|
+
#
|
3898
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies
|
3899
|
+
# @return [Array<Types::PolicyToPath>]
|
3900
|
+
#
|
3901
|
+
# @!attribute [rw] next_token
|
3902
|
+
# The pagination token.
|
3903
|
+
# @return [String]
|
3904
|
+
#
|
3905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyResponse AWS API Documentation
|
3906
|
+
#
|
3907
|
+
class LookupPolicyResponse < Struct.new(
|
3908
|
+
:policy_to_path_list,
|
3909
|
+
:next_token)
|
3910
|
+
include Aws::Structure
|
3911
|
+
end
|
3912
|
+
|
3913
|
+
# The action to take on the object attribute.
|
3914
|
+
#
|
3915
|
+
# @note When making an API call, you may pass ObjectAttributeAction
|
3916
|
+
# data as a hash:
|
3917
|
+
#
|
3918
|
+
# {
|
3919
|
+
# object_attribute_action_type: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
|
3920
|
+
# object_attribute_update_value: {
|
3921
|
+
# string_value: "StringAttributeValue",
|
3922
|
+
# binary_value: "data",
|
3923
|
+
# boolean_value: false,
|
3924
|
+
# number_value: "NumberAttributeValue",
|
3925
|
+
# datetime_value: Time.now,
|
3926
|
+
# },
|
3927
|
+
# }
|
3928
|
+
#
|
3929
|
+
# @!attribute [rw] object_attribute_action_type
|
3930
|
+
# A type that can be either `Update` or `Delete`.
|
3931
|
+
# @return [String]
|
3932
|
+
#
|
3933
|
+
# @!attribute [rw] object_attribute_update_value
|
3934
|
+
# The value that you want to update to.
|
3935
|
+
# @return [Types::TypedAttributeValue]
|
3936
|
+
#
|
3937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeAction AWS API Documentation
|
3938
|
+
#
|
3939
|
+
class ObjectAttributeAction < Struct.new(
|
3940
|
+
:object_attribute_action_type,
|
3941
|
+
:object_attribute_update_value)
|
3942
|
+
include Aws::Structure
|
3943
|
+
end
|
3944
|
+
|
3945
|
+
# A range of attributes.
|
3946
|
+
#
|
3947
|
+
# @note When making an API call, you may pass ObjectAttributeRange
|
3331
3948
|
# data as a hash:
|
3332
3949
|
#
|
3333
3950
|
# {
|
@@ -3357,7 +3974,7 @@ module Aws::CloudDirectory
|
|
3357
3974
|
# }
|
3358
3975
|
#
|
3359
3976
|
# @!attribute [rw] attribute_key
|
3360
|
-
# The key of the attribute the attribute range covers.
|
3977
|
+
# The key of the attribute that the attribute range covers.
|
3361
3978
|
# @return [Types::AttributeKey]
|
3362
3979
|
#
|
3363
3980
|
# @!attribute [rw] range
|
@@ -3411,7 +4028,7 @@ module Aws::CloudDirectory
|
|
3411
4028
|
include Aws::Structure
|
3412
4029
|
end
|
3413
4030
|
|
3414
|
-
#
|
4031
|
+
# The reference that identifies an object.
|
3415
4032
|
#
|
3416
4033
|
# @note When making an API call, you may pass ObjectReference
|
3417
4034
|
# data as a hash:
|
@@ -3421,14 +4038,27 @@ module Aws::CloudDirectory
|
|
3421
4038
|
# }
|
3422
4039
|
#
|
3423
4040
|
# @!attribute [rw] selector
|
3424
|
-
#
|
3425
|
-
#
|
3426
|
-
#
|
3427
|
-
#
|
4041
|
+
# A path selector supports easy selection of an object by the
|
4042
|
+
# parent/child links leading to it from the directory root. Use the
|
4043
|
+
# link names from each parent/child link to construct the path. Path
|
4044
|
+
# selectors start with a slash (/) and link names are separated by
|
4045
|
+
# slashes. For more information about paths, see [Accessing
|
4046
|
+
# Objects][1]. You can identify an object in one of the following
|
4047
|
+
# ways:
|
4048
|
+
#
|
4049
|
+
# * *$ObjectIdentifier* - An object identifier is an opaque string
|
4050
|
+
# provided by Amazon Cloud Directory. When creating objects, the
|
4051
|
+
# system will provide you with the identifier of the created object.
|
4052
|
+
# An object’s identifier is immutable and no two objects will ever
|
4053
|
+
# share the same object identifier
|
3428
4054
|
#
|
3429
4055
|
# * */some/path* - Identifies the object based on path
|
3430
4056
|
#
|
3431
4057
|
# * *#SomeBatchReference* - Identifies the object in a batch call
|
4058
|
+
#
|
4059
|
+
#
|
4060
|
+
#
|
4061
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#accessingobjects
|
3432
4062
|
# @return [String]
|
3433
4063
|
#
|
3434
4064
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectReference AWS API Documentation
|
@@ -3438,11 +4068,12 @@ module Aws::CloudDirectory
|
|
3438
4068
|
include Aws::Structure
|
3439
4069
|
end
|
3440
4070
|
|
3441
|
-
# Returns the path to the `ObjectIdentifiers` associated with
|
3442
|
-
# directory.
|
4071
|
+
# Returns the path to the `ObjectIdentifiers` that is associated with
|
4072
|
+
# the directory.
|
3443
4073
|
#
|
3444
4074
|
# @!attribute [rw] path
|
3445
|
-
# The path used to identify the object starting from directory
|
4075
|
+
# The path that is used to identify the object starting from directory
|
4076
|
+
# root.
|
3446
4077
|
# @return [String]
|
3447
4078
|
#
|
3448
4079
|
# @!attribute [rw] object_identifiers
|
@@ -3459,14 +4090,18 @@ module Aws::CloudDirectory
|
|
3459
4090
|
end
|
3460
4091
|
|
3461
4092
|
# Contains the `PolicyType`, `PolicyId`, and the `ObjectIdentifier` to
|
3462
|
-
# which it is attached.
|
4093
|
+
# which it is attached. For more information, see [Policies][1].
|
4094
|
+
#
|
4095
|
+
#
|
4096
|
+
#
|
4097
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies
|
3463
4098
|
#
|
3464
4099
|
# @!attribute [rw] policy_id
|
3465
4100
|
# The ID of `PolicyAttachment`.
|
3466
4101
|
# @return [String]
|
3467
4102
|
#
|
3468
4103
|
# @!attribute [rw] object_identifier
|
3469
|
-
# The `ObjectIdentifier` associated with `PolicyAttachment`.
|
4104
|
+
# The `ObjectIdentifier` that is associated with `PolicyAttachment`.
|
3470
4105
|
# @return [String]
|
3471
4106
|
#
|
3472
4107
|
# @!attribute [rw] policy_type
|
@@ -3483,8 +4118,8 @@ module Aws::CloudDirectory
|
|
3483
4118
|
end
|
3484
4119
|
|
3485
4120
|
# Used when a regular object exists in a Directory and you want to find
|
3486
|
-
# all of the policies associated with that object and the
|
3487
|
-
# object.
|
4121
|
+
# all of the policies that are associated with that object and the
|
4122
|
+
# parent to that object.
|
3488
4123
|
#
|
3489
4124
|
# @!attribute [rw] path
|
3490
4125
|
# The path that is referenced from the root.
|
@@ -3512,17 +4147,17 @@ module Aws::CloudDirectory
|
|
3512
4147
|
# }
|
3513
4148
|
#
|
3514
4149
|
# @!attribute [rw] development_schema_arn
|
3515
|
-
#
|
3516
|
-
# see arns.
|
4150
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
4151
|
+
# development schema. For more information, see arns.
|
3517
4152
|
# @return [String]
|
3518
4153
|
#
|
3519
4154
|
# @!attribute [rw] version
|
3520
|
-
#
|
4155
|
+
# The version under which the schema will be published.
|
3521
4156
|
# @return [String]
|
3522
4157
|
#
|
3523
4158
|
# @!attribute [rw] name
|
3524
|
-
#
|
3525
|
-
# provided, the development schema is considered.
|
4159
|
+
# The new name under which the schema will be published. If this is
|
4160
|
+
# not provided, the development schema is considered.
|
3526
4161
|
# @return [String]
|
3527
4162
|
#
|
3528
4163
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaRequest AWS API Documentation
|
@@ -3535,8 +4170,8 @@ module Aws::CloudDirectory
|
|
3535
4170
|
end
|
3536
4171
|
|
3537
4172
|
# @!attribute [rw] published_schema_arn
|
3538
|
-
# ARN associated with the published schema. For more
|
3539
|
-
# arns.
|
4173
|
+
# The ARN that is associated with the published schema. For more
|
4174
|
+
# information, see arns.
|
3540
4175
|
# @return [String]
|
3541
4176
|
#
|
3542
4177
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaResponse AWS API Documentation
|
@@ -3620,7 +4255,8 @@ module Aws::CloudDirectory
|
|
3620
4255
|
#
|
3621
4256
|
class RemoveFacetFromObjectResponse < Aws::EmptyStructure; end
|
3622
4257
|
|
3623
|
-
# Contains an ARN and parameters
|
4258
|
+
# Contains an Amazon Resource Name (ARN) and parameters that are
|
4259
|
+
# associated with the rule.
|
3624
4260
|
#
|
3625
4261
|
# @note When making an API call, you may pass Rule
|
3626
4262
|
# data as a hash:
|
@@ -3637,7 +4273,8 @@ module Aws::CloudDirectory
|
|
3637
4273
|
# @return [String]
|
3638
4274
|
#
|
3639
4275
|
# @!attribute [rw] parameters
|
3640
|
-
#
|
4276
|
+
# The minimum and maximum parameters that are associated with the
|
4277
|
+
# rule.
|
3641
4278
|
# @return [Hash<String,String>]
|
3642
4279
|
#
|
3643
4280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Rule AWS API Documentation
|
@@ -3674,7 +4311,7 @@ module Aws::CloudDirectory
|
|
3674
4311
|
include Aws::Structure
|
3675
4312
|
end
|
3676
4313
|
|
3677
|
-
#
|
4314
|
+
# The tag structure that contains a tag key and value.
|
3678
4315
|
#
|
3679
4316
|
# @note When making an API call, you may pass Tag
|
3680
4317
|
# data as a hash:
|
@@ -3685,11 +4322,11 @@ module Aws::CloudDirectory
|
|
3685
4322
|
# }
|
3686
4323
|
#
|
3687
4324
|
# @!attribute [rw] key
|
3688
|
-
#
|
4325
|
+
# The key that is associated with the tag.
|
3689
4326
|
# @return [String]
|
3690
4327
|
#
|
3691
4328
|
# @!attribute [rw] value
|
3692
|
-
#
|
4329
|
+
# The value that is associated with the tag.
|
3693
4330
|
# @return [String]
|
3694
4331
|
#
|
3695
4332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Tag AWS API Documentation
|
@@ -3714,11 +4351,12 @@ module Aws::CloudDirectory
|
|
3714
4351
|
# }
|
3715
4352
|
#
|
3716
4353
|
# @!attribute [rw] resource_arn
|
3717
|
-
# ARN of the resource. Tagging is only
|
4354
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
4355
|
+
# supported for directories.
|
3718
4356
|
# @return [String]
|
3719
4357
|
#
|
3720
4358
|
# @!attribute [rw] tags
|
3721
|
-
#
|
4359
|
+
# A list of tag key-value pairs.
|
3722
4360
|
# @return [Array<Types::Tag>]
|
3723
4361
|
#
|
3724
4362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResourceRequest AWS API Documentation
|
@@ -3804,7 +4442,7 @@ module Aws::CloudDirectory
|
|
3804
4442
|
# }
|
3805
4443
|
#
|
3806
4444
|
# @!attribute [rw] start_mode
|
3807
|
-
#
|
4445
|
+
# The inclusive or exclusive range start.
|
3808
4446
|
# @return [String]
|
3809
4447
|
#
|
3810
4448
|
# @!attribute [rw] start_value
|
@@ -3812,7 +4450,7 @@ module Aws::CloudDirectory
|
|
3812
4450
|
# @return [Types::TypedAttributeValue]
|
3813
4451
|
#
|
3814
4452
|
# @!attribute [rw] end_mode
|
3815
|
-
#
|
4453
|
+
# The inclusive or exclusive range end.
|
3816
4454
|
# @return [String]
|
3817
4455
|
#
|
3818
4456
|
# @!attribute [rw] end_value
|
@@ -3829,6 +4467,312 @@ module Aws::CloudDirectory
|
|
3829
4467
|
include Aws::Structure
|
3830
4468
|
end
|
3831
4469
|
|
4470
|
+
# A typed link attribute definition.
|
4471
|
+
#
|
4472
|
+
# @note When making an API call, you may pass TypedLinkAttributeDefinition
|
4473
|
+
# data as a hash:
|
4474
|
+
#
|
4475
|
+
# {
|
4476
|
+
# name: "AttributeName", # required
|
4477
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
4478
|
+
# default_value: {
|
4479
|
+
# string_value: "StringAttributeValue",
|
4480
|
+
# binary_value: "data",
|
4481
|
+
# boolean_value: false,
|
4482
|
+
# number_value: "NumberAttributeValue",
|
4483
|
+
# datetime_value: Time.now,
|
4484
|
+
# },
|
4485
|
+
# is_immutable: false,
|
4486
|
+
# rules: {
|
4487
|
+
# "RuleKey" => {
|
4488
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
4489
|
+
# parameters: {
|
4490
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
4491
|
+
# },
|
4492
|
+
# },
|
4493
|
+
# },
|
4494
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
4495
|
+
# }
|
4496
|
+
#
|
4497
|
+
# @!attribute [rw] name
|
4498
|
+
# The unique name of the typed link attribute.
|
4499
|
+
# @return [String]
|
4500
|
+
#
|
4501
|
+
# @!attribute [rw] type
|
4502
|
+
# The type of the attribute.
|
4503
|
+
# @return [String]
|
4504
|
+
#
|
4505
|
+
# @!attribute [rw] default_value
|
4506
|
+
# The default value of the attribute (if configured).
|
4507
|
+
# @return [Types::TypedAttributeValue]
|
4508
|
+
#
|
4509
|
+
# @!attribute [rw] is_immutable
|
4510
|
+
# Whether the attribute is mutable or not.
|
4511
|
+
# @return [Boolean]
|
4512
|
+
#
|
4513
|
+
# @!attribute [rw] rules
|
4514
|
+
# Validation rules that are attached to the attribute definition.
|
4515
|
+
# @return [Hash<String,Types::Rule>]
|
4516
|
+
#
|
4517
|
+
# @!attribute [rw] required_behavior
|
4518
|
+
# The required behavior of the `TypedLinkAttributeDefinition`.
|
4519
|
+
# @return [String]
|
4520
|
+
#
|
4521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkAttributeDefinition AWS API Documentation
|
4522
|
+
#
|
4523
|
+
class TypedLinkAttributeDefinition < Struct.new(
|
4524
|
+
:name,
|
4525
|
+
:type,
|
4526
|
+
:default_value,
|
4527
|
+
:is_immutable,
|
4528
|
+
:rules,
|
4529
|
+
:required_behavior)
|
4530
|
+
include Aws::Structure
|
4531
|
+
end
|
4532
|
+
|
4533
|
+
# Identifies the range of attributes that are used by a specified
|
4534
|
+
# filter.
|
4535
|
+
#
|
4536
|
+
# @note When making an API call, you may pass TypedLinkAttributeRange
|
4537
|
+
# data as a hash:
|
4538
|
+
#
|
4539
|
+
# {
|
4540
|
+
# attribute_name: "AttributeName",
|
4541
|
+
# range: { # required
|
4542
|
+
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
4543
|
+
# start_value: {
|
4544
|
+
# string_value: "StringAttributeValue",
|
4545
|
+
# binary_value: "data",
|
4546
|
+
# boolean_value: false,
|
4547
|
+
# number_value: "NumberAttributeValue",
|
4548
|
+
# datetime_value: Time.now,
|
4549
|
+
# },
|
4550
|
+
# end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
4551
|
+
# end_value: {
|
4552
|
+
# string_value: "StringAttributeValue",
|
4553
|
+
# binary_value: "data",
|
4554
|
+
# boolean_value: false,
|
4555
|
+
# number_value: "NumberAttributeValue",
|
4556
|
+
# datetime_value: Time.now,
|
4557
|
+
# },
|
4558
|
+
# },
|
4559
|
+
# }
|
4560
|
+
#
|
4561
|
+
# @!attribute [rw] attribute_name
|
4562
|
+
# The unique name of the typed link attribute.
|
4563
|
+
# @return [String]
|
4564
|
+
#
|
4565
|
+
# @!attribute [rw] range
|
4566
|
+
# The range of attribute values that are being selected.
|
4567
|
+
# @return [Types::TypedAttributeValueRange]
|
4568
|
+
#
|
4569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkAttributeRange AWS API Documentation
|
4570
|
+
#
|
4571
|
+
class TypedLinkAttributeRange < Struct.new(
|
4572
|
+
:attribute_name,
|
4573
|
+
:range)
|
4574
|
+
include Aws::Structure
|
4575
|
+
end
|
4576
|
+
|
4577
|
+
# Defines the typed links structure and its attributes. To create a
|
4578
|
+
# typed link facet, use the CreateTypedLinkFacet API.
|
4579
|
+
#
|
4580
|
+
# @note When making an API call, you may pass TypedLinkFacet
|
4581
|
+
# data as a hash:
|
4582
|
+
#
|
4583
|
+
# {
|
4584
|
+
# name: "TypedLinkName", # required
|
4585
|
+
# attributes: [ # required
|
4586
|
+
# {
|
4587
|
+
# name: "AttributeName", # required
|
4588
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
4589
|
+
# default_value: {
|
4590
|
+
# string_value: "StringAttributeValue",
|
4591
|
+
# binary_value: "data",
|
4592
|
+
# boolean_value: false,
|
4593
|
+
# number_value: "NumberAttributeValue",
|
4594
|
+
# datetime_value: Time.now,
|
4595
|
+
# },
|
4596
|
+
# is_immutable: false,
|
4597
|
+
# rules: {
|
4598
|
+
# "RuleKey" => {
|
4599
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
4600
|
+
# parameters: {
|
4601
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
4602
|
+
# },
|
4603
|
+
# },
|
4604
|
+
# },
|
4605
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
4606
|
+
# },
|
4607
|
+
# ],
|
4608
|
+
# identity_attribute_order: ["AttributeName"], # required
|
4609
|
+
# }
|
4610
|
+
#
|
4611
|
+
# @!attribute [rw] name
|
4612
|
+
# The unique name of the typed link facet.
|
4613
|
+
# @return [String]
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] attributes
|
4616
|
+
# A set of key-value pairs associated with the typed link. Typed link
|
4617
|
+
# attributes are used when you have data values that are related to
|
4618
|
+
# the link itself, and not to one of the two objects being linked.
|
4619
|
+
# Identity attributes also serve to distinguish the link from others
|
4620
|
+
# of the same type between the same objects.
|
4621
|
+
# @return [Array<Types::TypedLinkAttributeDefinition>]
|
4622
|
+
#
|
4623
|
+
# @!attribute [rw] identity_attribute_order
|
4624
|
+
# The set of attributes that distinguish links made from this facet
|
4625
|
+
# from each other, in the order of significance. Listing typed links
|
4626
|
+
# can filter on the values of these attributes. See
|
4627
|
+
# ListOutgoingTypedLinks and ListIncomingTypeLinks for details.
|
4628
|
+
# @return [Array<String>]
|
4629
|
+
#
|
4630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkFacet AWS API Documentation
|
4631
|
+
#
|
4632
|
+
class TypedLinkFacet < Struct.new(
|
4633
|
+
:name,
|
4634
|
+
:attributes,
|
4635
|
+
:identity_attribute_order)
|
4636
|
+
include Aws::Structure
|
4637
|
+
end
|
4638
|
+
|
4639
|
+
# A typed link facet attribute update.
|
4640
|
+
#
|
4641
|
+
# @note When making an API call, you may pass TypedLinkFacetAttributeUpdate
|
4642
|
+
# data as a hash:
|
4643
|
+
#
|
4644
|
+
# {
|
4645
|
+
# attribute: { # required
|
4646
|
+
# name: "AttributeName", # required
|
4647
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
4648
|
+
# default_value: {
|
4649
|
+
# string_value: "StringAttributeValue",
|
4650
|
+
# binary_value: "data",
|
4651
|
+
# boolean_value: false,
|
4652
|
+
# number_value: "NumberAttributeValue",
|
4653
|
+
# datetime_value: Time.now,
|
4654
|
+
# },
|
4655
|
+
# is_immutable: false,
|
4656
|
+
# rules: {
|
4657
|
+
# "RuleKey" => {
|
4658
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
4659
|
+
# parameters: {
|
4660
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
4661
|
+
# },
|
4662
|
+
# },
|
4663
|
+
# },
|
4664
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
4665
|
+
# },
|
4666
|
+
# action: "CREATE_OR_UPDATE", # required, accepts CREATE_OR_UPDATE, DELETE
|
4667
|
+
# }
|
4668
|
+
#
|
4669
|
+
# @!attribute [rw] attribute
|
4670
|
+
# The attribute to update.
|
4671
|
+
# @return [Types::TypedLinkAttributeDefinition]
|
4672
|
+
#
|
4673
|
+
# @!attribute [rw] action
|
4674
|
+
# The action to perform when updating the attribute.
|
4675
|
+
# @return [String]
|
4676
|
+
#
|
4677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkFacetAttributeUpdate AWS API Documentation
|
4678
|
+
#
|
4679
|
+
class TypedLinkFacetAttributeUpdate < Struct.new(
|
4680
|
+
:attribute,
|
4681
|
+
:action)
|
4682
|
+
include Aws::Structure
|
4683
|
+
end
|
4684
|
+
|
4685
|
+
# Identifies the schema Amazon Resource Name (ARN) and facet name for
|
4686
|
+
# the typed link.
|
4687
|
+
#
|
4688
|
+
# @note When making an API call, you may pass TypedLinkSchemaAndFacetName
|
4689
|
+
# data as a hash:
|
4690
|
+
#
|
4691
|
+
# {
|
4692
|
+
# schema_arn: "Arn", # required
|
4693
|
+
# typed_link_name: "TypedLinkName", # required
|
4694
|
+
# }
|
4695
|
+
#
|
4696
|
+
# @!attribute [rw] schema_arn
|
4697
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
4698
|
+
# For more information, see arns.
|
4699
|
+
# @return [String]
|
4700
|
+
#
|
4701
|
+
# @!attribute [rw] typed_link_name
|
4702
|
+
# The unique name of the typed link facet.
|
4703
|
+
# @return [String]
|
4704
|
+
#
|
4705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkSchemaAndFacetName AWS API Documentation
|
4706
|
+
#
|
4707
|
+
class TypedLinkSchemaAndFacetName < Struct.new(
|
4708
|
+
:schema_arn,
|
4709
|
+
:typed_link_name)
|
4710
|
+
include Aws::Structure
|
4711
|
+
end
|
4712
|
+
|
4713
|
+
# Contains all the information that is used to uniquely identify a typed
|
4714
|
+
# link. The parameters discussed in this topic are used to uniquely
|
4715
|
+
# specify the typed link being operated on. The AttachTypedLink API
|
4716
|
+
# returns a typed link specifier while the DetachTypedLink API accepts
|
4717
|
+
# one as input. Similarly, the ListIncomingTypedLinks and
|
4718
|
+
# ListOutgoingTypedLinks API operations provide typed link specifiers as
|
4719
|
+
# output. You can also construct a typed link specifier from scratch.
|
4720
|
+
#
|
4721
|
+
# @note When making an API call, you may pass TypedLinkSpecifier
|
4722
|
+
# data as a hash:
|
4723
|
+
#
|
4724
|
+
# {
|
4725
|
+
# typed_link_facet: { # required
|
4726
|
+
# schema_arn: "Arn", # required
|
4727
|
+
# typed_link_name: "TypedLinkName", # required
|
4728
|
+
# },
|
4729
|
+
# source_object_reference: { # required
|
4730
|
+
# selector: "SelectorObjectReference",
|
4731
|
+
# },
|
4732
|
+
# target_object_reference: { # required
|
4733
|
+
# selector: "SelectorObjectReference",
|
4734
|
+
# },
|
4735
|
+
# identity_attribute_values: [ # required
|
4736
|
+
# {
|
4737
|
+
# attribute_name: "AttributeName", # required
|
4738
|
+
# value: { # required
|
4739
|
+
# string_value: "StringAttributeValue",
|
4740
|
+
# binary_value: "data",
|
4741
|
+
# boolean_value: false,
|
4742
|
+
# number_value: "NumberAttributeValue",
|
4743
|
+
# datetime_value: Time.now,
|
4744
|
+
# },
|
4745
|
+
# },
|
4746
|
+
# ],
|
4747
|
+
# }
|
4748
|
+
#
|
4749
|
+
# @!attribute [rw] typed_link_facet
|
4750
|
+
# Identifies the typed link facet that is associated with the typed
|
4751
|
+
# link.
|
4752
|
+
# @return [Types::TypedLinkSchemaAndFacetName]
|
4753
|
+
#
|
4754
|
+
# @!attribute [rw] source_object_reference
|
4755
|
+
# Identifies the source object that the typed link will attach to.
|
4756
|
+
# @return [Types::ObjectReference]
|
4757
|
+
#
|
4758
|
+
# @!attribute [rw] target_object_reference
|
4759
|
+
# Identifies the target object that the typed link will attach to.
|
4760
|
+
# @return [Types::ObjectReference]
|
4761
|
+
#
|
4762
|
+
# @!attribute [rw] identity_attribute_values
|
4763
|
+
# Identifies the attribute value to update.
|
4764
|
+
# @return [Array<Types::AttributeNameAndValue>]
|
4765
|
+
#
|
4766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedLinkSpecifier AWS API Documentation
|
4767
|
+
#
|
4768
|
+
class TypedLinkSpecifier < Struct.new(
|
4769
|
+
:typed_link_facet,
|
4770
|
+
:source_object_reference,
|
4771
|
+
:target_object_reference,
|
4772
|
+
:identity_attribute_values)
|
4773
|
+
include Aws::Structure
|
4774
|
+
end
|
4775
|
+
|
3832
4776
|
# @note When making an API call, you may pass UntagResourceRequest
|
3833
4777
|
# data as a hash:
|
3834
4778
|
#
|
@@ -3838,11 +4782,12 @@ module Aws::CloudDirectory
|
|
3838
4782
|
# }
|
3839
4783
|
#
|
3840
4784
|
# @!attribute [rw] resource_arn
|
3841
|
-
# ARN of the resource. Tagging is only
|
4785
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
4786
|
+
# supported for directories.
|
3842
4787
|
# @return [String]
|
3843
4788
|
#
|
3844
4789
|
# @!attribute [rw] tag_keys
|
3845
|
-
# Keys of the tag that
|
4790
|
+
# Keys of the tag that need to be removed from the resource.
|
3846
4791
|
# @return [Array<String>]
|
3847
4792
|
#
|
3848
4793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResourceRequest AWS API Documentation
|
@@ -3899,20 +4844,22 @@ module Aws::CloudDirectory
|
|
3899
4844
|
# }
|
3900
4845
|
#
|
3901
4846
|
# @!attribute [rw] schema_arn
|
3902
|
-
# ARN associated with the Facet.
|
4847
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet.
|
4848
|
+
# For more information, see arns.
|
3903
4849
|
# @return [String]
|
3904
4850
|
#
|
3905
4851
|
# @!attribute [rw] name
|
4852
|
+
# The name of the facet.
|
3906
4853
|
# @return [String]
|
3907
4854
|
#
|
3908
4855
|
# @!attribute [rw] attribute_updates
|
3909
4856
|
# List of attributes that need to be updated in a given schema Facet.
|
3910
|
-
# Each attribute is followed by AttributeAction
|
4857
|
+
# Each attribute is followed by `AttributeAction`, which specifies the
|
3911
4858
|
# type of update operation to perform.
|
3912
4859
|
# @return [Array<Types::FacetAttributeUpdate>]
|
3913
4860
|
#
|
3914
4861
|
# @!attribute [rw] object_type
|
3915
|
-
#
|
4862
|
+
# The object type that is associated with the facet. See
|
3916
4863
|
# CreateFacetRequest$ObjectType for more details.
|
3917
4864
|
# @return [String]
|
3918
4865
|
#
|
@@ -3960,16 +4907,16 @@ module Aws::CloudDirectory
|
|
3960
4907
|
# }
|
3961
4908
|
#
|
3962
4909
|
# @!attribute [rw] directory_arn
|
3963
|
-
#
|
3964
|
-
# information, see arns.
|
4910
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
4911
|
+
# where the object resides. For more information, see arns.
|
3965
4912
|
# @return [String]
|
3966
4913
|
#
|
3967
4914
|
# @!attribute [rw] object_reference
|
3968
|
-
#
|
4915
|
+
# The reference that identifies the object.
|
3969
4916
|
# @return [Types::ObjectReference]
|
3970
4917
|
#
|
3971
4918
|
# @!attribute [rw] attribute_updates
|
3972
|
-
#
|
4919
|
+
# The attributes update structure.
|
3973
4920
|
# @return [Array<Types::ObjectAttributeUpdate>]
|
3974
4921
|
#
|
3975
4922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesRequest AWS API Documentation
|
@@ -3982,7 +4929,7 @@ module Aws::CloudDirectory
|
|
3982
4929
|
end
|
3983
4930
|
|
3984
4931
|
# @!attribute [rw] object_identifier
|
3985
|
-
# `ObjectIdentifier` of the updated object.
|
4932
|
+
# The `ObjectIdentifier` of the updated object.
|
3986
4933
|
# @return [String]
|
3987
4934
|
#
|
3988
4935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesResponse AWS API Documentation
|
@@ -4001,11 +4948,12 @@ module Aws::CloudDirectory
|
|
4001
4948
|
# }
|
4002
4949
|
#
|
4003
4950
|
# @!attribute [rw] schema_arn
|
4004
|
-
# ARN of the development schema. For more
|
4951
|
+
# The Amazon Resource Name (ARN) of the development schema. For more
|
4952
|
+
# information, see arns.
|
4005
4953
|
# @return [String]
|
4006
4954
|
#
|
4007
4955
|
# @!attribute [rw] name
|
4008
|
-
#
|
4956
|
+
# The name of the schema.
|
4009
4957
|
# @return [String]
|
4010
4958
|
#
|
4011
4959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaRequest AWS API Documentation
|
@@ -4017,8 +4965,8 @@ module Aws::CloudDirectory
|
|
4017
4965
|
end
|
4018
4966
|
|
4019
4967
|
# @!attribute [rw] schema_arn
|
4020
|
-
# ARN associated with the updated schema. For more
|
4021
|
-
# arns.
|
4968
|
+
# The ARN that is associated with the updated schema. For more
|
4969
|
+
# information, see arns.
|
4022
4970
|
# @return [String]
|
4023
4971
|
#
|
4024
4972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaResponse AWS API Documentation
|
@@ -4028,5 +4976,84 @@ module Aws::CloudDirectory
|
|
4028
4976
|
include Aws::Structure
|
4029
4977
|
end
|
4030
4978
|
|
4979
|
+
# @note When making an API call, you may pass UpdateTypedLinkFacetRequest
|
4980
|
+
# data as a hash:
|
4981
|
+
#
|
4982
|
+
# {
|
4983
|
+
# schema_arn: "Arn", # required
|
4984
|
+
# name: "TypedLinkName", # required
|
4985
|
+
# attribute_updates: [ # required
|
4986
|
+
# {
|
4987
|
+
# attribute: { # required
|
4988
|
+
# name: "AttributeName", # required
|
4989
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
4990
|
+
# default_value: {
|
4991
|
+
# string_value: "StringAttributeValue",
|
4992
|
+
# binary_value: "data",
|
4993
|
+
# boolean_value: false,
|
4994
|
+
# number_value: "NumberAttributeValue",
|
4995
|
+
# datetime_value: Time.now,
|
4996
|
+
# },
|
4997
|
+
# is_immutable: false,
|
4998
|
+
# rules: {
|
4999
|
+
# "RuleKey" => {
|
5000
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
5001
|
+
# parameters: {
|
5002
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
5003
|
+
# },
|
5004
|
+
# },
|
5005
|
+
# },
|
5006
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
5007
|
+
# },
|
5008
|
+
# action: "CREATE_OR_UPDATE", # required, accepts CREATE_OR_UPDATE, DELETE
|
5009
|
+
# },
|
5010
|
+
# ],
|
5011
|
+
# identity_attribute_order: ["AttributeName"], # required
|
5012
|
+
# }
|
5013
|
+
#
|
5014
|
+
# @!attribute [rw] schema_arn
|
5015
|
+
# The Amazon Resource Name (ARN) that is associated with the schema.
|
5016
|
+
# For more information, see arns.
|
5017
|
+
# @return [String]
|
5018
|
+
#
|
5019
|
+
# @!attribute [rw] name
|
5020
|
+
# The unique name of the typed link facet.
|
5021
|
+
# @return [String]
|
5022
|
+
#
|
5023
|
+
# @!attribute [rw] attribute_updates
|
5024
|
+
# Attributes update structure.
|
5025
|
+
# @return [Array<Types::TypedLinkFacetAttributeUpdate>]
|
5026
|
+
#
|
5027
|
+
# @!attribute [rw] identity_attribute_order
|
5028
|
+
# The order of identity attributes for the facet, from most
|
5029
|
+
# significant to least significant. The ability to filter typed links
|
5030
|
+
# considers the order that the attributes are defined on the typed
|
5031
|
+
# link facet. When providing ranges to a typed link selection, any
|
5032
|
+
# inexact ranges must be specified at the end. Any attributes that do
|
5033
|
+
# not have a range specified are presumed to match the entire range.
|
5034
|
+
# Filters are interpreted in the order of the attributes on the typed
|
5035
|
+
# link facet, not the order in which they are supplied to any API
|
5036
|
+
# calls. For more information about identity attributes, see [Typed
|
5037
|
+
# link][1].
|
5038
|
+
#
|
5039
|
+
#
|
5040
|
+
#
|
5041
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
5042
|
+
# @return [Array<String>]
|
5043
|
+
#
|
5044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateTypedLinkFacetRequest AWS API Documentation
|
5045
|
+
#
|
5046
|
+
class UpdateTypedLinkFacetRequest < Struct.new(
|
5047
|
+
:schema_arn,
|
5048
|
+
:name,
|
5049
|
+
:attribute_updates,
|
5050
|
+
:identity_attribute_order)
|
5051
|
+
include Aws::Structure
|
5052
|
+
end
|
5053
|
+
|
5054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateTypedLinkFacetResponse AWS API Documentation
|
5055
|
+
#
|
5056
|
+
class UpdateTypedLinkFacetResponse < Aws::EmptyStructure; end
|
5057
|
+
|
4031
5058
|
end
|
4032
5059
|
end
|