aws-sdk-clouddirectory 1.0.0.rc5 → 1.0.0.rc6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +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
|
@@ -148,14 +148,14 @@ module Aws::CloudDirectory
|
|
|
148
148
|
# Adds a new Facet to an object.
|
|
149
149
|
#
|
|
150
150
|
# @option params [required, String] :directory_arn
|
|
151
|
-
#
|
|
152
|
-
# information, see arns.
|
|
151
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
152
|
+
# where the object resides. For more information, see arns.
|
|
153
153
|
#
|
|
154
154
|
# @option params [required, Types::SchemaFacet] :schema_facet
|
|
155
155
|
# Identifiers for the facet that you are adding to the object.
|
|
156
156
|
#
|
|
157
157
|
# @option params [Array<Types::AttributeKeyAndValue>] :object_attribute_list
|
|
158
|
-
# Attributes on the facet you are adding to the object.
|
|
158
|
+
# Attributes on the facet that you are adding to the object.
|
|
159
159
|
#
|
|
160
160
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
161
161
|
# A reference to the object you are adding the specified facet to.
|
|
@@ -200,16 +200,16 @@ module Aws::CloudDirectory
|
|
|
200
200
|
req.send_request(options)
|
|
201
201
|
end
|
|
202
202
|
|
|
203
|
-
# Copies input published schema into Directory with same
|
|
204
|
-
# version as that of published schema .
|
|
203
|
+
# Copies the input published schema into the Directory with the same
|
|
204
|
+
# name and version as that of the published schema .
|
|
205
205
|
#
|
|
206
206
|
# @option params [required, String] :published_schema_arn
|
|
207
|
-
# Published schema ARN that needs to be copied.
|
|
208
|
-
# see arns.
|
|
207
|
+
# Published schema Amazon Resource Name (ARN) that needs to be copied.
|
|
208
|
+
# For more information, see arns.
|
|
209
209
|
#
|
|
210
210
|
# @option params [required, String] :directory_arn
|
|
211
|
-
#
|
|
212
|
-
# more information, see arns.
|
|
211
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
212
|
+
# into which the schema is copied. For more information, see arns.
|
|
213
213
|
#
|
|
214
214
|
# @return [Types::ApplySchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
215
215
|
#
|
|
@@ -245,17 +245,17 @@ module Aws::CloudDirectory
|
|
|
245
245
|
# 2. Using `ObjectIdentifier`
|
|
246
246
|
#
|
|
247
247
|
# @option params [required, String] :directory_arn
|
|
248
|
-
# ARN associated with the Directory where
|
|
249
|
-
# information, see arns.
|
|
248
|
+
# Amazon Resource Name (ARN) that is associated with the Directory where
|
|
249
|
+
# both objects reside. For more information, see arns.
|
|
250
250
|
#
|
|
251
251
|
# @option params [required, Types::ObjectReference] :parent_reference
|
|
252
|
-
#
|
|
252
|
+
# The parent object reference.
|
|
253
253
|
#
|
|
254
254
|
# @option params [required, Types::ObjectReference] :child_reference
|
|
255
|
-
#
|
|
255
|
+
# The child object reference to be attached to the object.
|
|
256
256
|
#
|
|
257
257
|
# @option params [required, String] :link_name
|
|
258
|
-
#
|
|
258
|
+
# The link name with which the child object is attached to the parent.
|
|
259
259
|
#
|
|
260
260
|
# @return [Types::AttachObjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
261
261
|
#
|
|
@@ -291,14 +291,14 @@ module Aws::CloudDirectory
|
|
|
291
291
|
# limited number of attached policies.
|
|
292
292
|
#
|
|
293
293
|
# @option params [String] :directory_arn
|
|
294
|
-
#
|
|
295
|
-
# information, see arns.
|
|
294
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
295
|
+
# where both objects reside. For more information, see arns.
|
|
296
296
|
#
|
|
297
297
|
# @option params [required, Types::ObjectReference] :policy_reference
|
|
298
|
-
#
|
|
298
|
+
# The reference that is associated with the policy object.
|
|
299
299
|
#
|
|
300
300
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
301
|
-
#
|
|
301
|
+
# The reference that identifies the object to which the policy will be
|
|
302
302
|
# attached.
|
|
303
303
|
#
|
|
304
304
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
@@ -327,7 +327,8 @@ module Aws::CloudDirectory
|
|
|
327
327
|
# Attaches the specified object to the specified index.
|
|
328
328
|
#
|
|
329
329
|
# @option params [required, String] :directory_arn
|
|
330
|
-
# The ARN of the directory where the object and
|
|
330
|
+
# The Amazon Resource Name (ARN) of the directory where the object and
|
|
331
|
+
# index exist.
|
|
331
332
|
#
|
|
332
333
|
# @option params [required, Types::ObjectReference] :index_reference
|
|
333
334
|
# A reference to the index that you are attaching the object to.
|
|
@@ -364,13 +365,93 @@ module Aws::CloudDirectory
|
|
|
364
365
|
req.send_request(options)
|
|
365
366
|
end
|
|
366
367
|
|
|
368
|
+
# Attaches a typed link to a specified source and target object. For
|
|
369
|
+
# more information, see [Typed link][1].
|
|
370
|
+
#
|
|
371
|
+
#
|
|
372
|
+
#
|
|
373
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
374
|
+
#
|
|
375
|
+
# @option params [required, String] :directory_arn
|
|
376
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
|
377
|
+
# attach the typed link.
|
|
378
|
+
#
|
|
379
|
+
# @option params [required, Types::ObjectReference] :source_object_reference
|
|
380
|
+
# Identifies the source object that the typed link will attach to.
|
|
381
|
+
#
|
|
382
|
+
# @option params [required, Types::ObjectReference] :target_object_reference
|
|
383
|
+
# Identifies the target object that the typed link will attach to.
|
|
384
|
+
#
|
|
385
|
+
# @option params [required, Types::TypedLinkSchemaAndFacetName] :typed_link_facet
|
|
386
|
+
# Identifies the typed link facet that is associated with the typed
|
|
387
|
+
# link.
|
|
388
|
+
#
|
|
389
|
+
# @option params [required, Array<Types::AttributeNameAndValue>] :attributes
|
|
390
|
+
# A set of attributes that are associated with the typed link.
|
|
391
|
+
#
|
|
392
|
+
# @return [Types::AttachTypedLinkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
393
|
+
#
|
|
394
|
+
# * {Types::AttachTypedLinkResponse#typed_link_specifier #typed_link_specifier} => Types::TypedLinkSpecifier
|
|
395
|
+
#
|
|
396
|
+
# @example Request syntax with placeholder values
|
|
397
|
+
#
|
|
398
|
+
# resp = client.attach_typed_link({
|
|
399
|
+
# directory_arn: "Arn", # required
|
|
400
|
+
# source_object_reference: { # required
|
|
401
|
+
# selector: "SelectorObjectReference",
|
|
402
|
+
# },
|
|
403
|
+
# target_object_reference: { # required
|
|
404
|
+
# selector: "SelectorObjectReference",
|
|
405
|
+
# },
|
|
406
|
+
# typed_link_facet: { # required
|
|
407
|
+
# schema_arn: "Arn", # required
|
|
408
|
+
# typed_link_name: "TypedLinkName", # required
|
|
409
|
+
# },
|
|
410
|
+
# attributes: [ # required
|
|
411
|
+
# {
|
|
412
|
+
# attribute_name: "AttributeName", # required
|
|
413
|
+
# value: { # required
|
|
414
|
+
# string_value: "StringAttributeValue",
|
|
415
|
+
# binary_value: "data",
|
|
416
|
+
# boolean_value: false,
|
|
417
|
+
# number_value: "NumberAttributeValue",
|
|
418
|
+
# datetime_value: Time.now,
|
|
419
|
+
# },
|
|
420
|
+
# },
|
|
421
|
+
# ],
|
|
422
|
+
# })
|
|
423
|
+
#
|
|
424
|
+
# @example Response structure
|
|
425
|
+
#
|
|
426
|
+
# resp.typed_link_specifier.typed_link_facet.schema_arn #=> String
|
|
427
|
+
# resp.typed_link_specifier.typed_link_facet.typed_link_name #=> String
|
|
428
|
+
# resp.typed_link_specifier.source_object_reference.selector #=> String
|
|
429
|
+
# resp.typed_link_specifier.target_object_reference.selector #=> String
|
|
430
|
+
# resp.typed_link_specifier.identity_attribute_values #=> Array
|
|
431
|
+
# resp.typed_link_specifier.identity_attribute_values[0].attribute_name #=> String
|
|
432
|
+
# resp.typed_link_specifier.identity_attribute_values[0].value.string_value #=> String
|
|
433
|
+
# resp.typed_link_specifier.identity_attribute_values[0].value.binary_value #=> String
|
|
434
|
+
# resp.typed_link_specifier.identity_attribute_values[0].value.boolean_value #=> Boolean
|
|
435
|
+
# resp.typed_link_specifier.identity_attribute_values[0].value.number_value #=> String
|
|
436
|
+
# resp.typed_link_specifier.identity_attribute_values[0].value.datetime_value #=> Time
|
|
437
|
+
#
|
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachTypedLink AWS API Documentation
|
|
439
|
+
#
|
|
440
|
+
# @overload attach_typed_link(params = {})
|
|
441
|
+
# @param [Hash] params ({})
|
|
442
|
+
def attach_typed_link(params = {}, options = {})
|
|
443
|
+
req = build_request(:attach_typed_link, params)
|
|
444
|
+
req.send_request(options)
|
|
445
|
+
end
|
|
446
|
+
|
|
367
447
|
# Performs all the read operations in a batch.
|
|
368
448
|
#
|
|
369
449
|
# @option params [required, String] :directory_arn
|
|
370
|
-
# ARN associated with the Directory.
|
|
450
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory.
|
|
451
|
+
# For more information, see arns.
|
|
371
452
|
#
|
|
372
453
|
# @option params [required, Array<Types::BatchReadOperation>] :operations
|
|
373
|
-
#
|
|
454
|
+
# A list of operations that are part of the batch.
|
|
374
455
|
#
|
|
375
456
|
# @option params [String] :consistency_level
|
|
376
457
|
# Represents the manner and timing in which the successful write or
|
|
@@ -443,10 +524,11 @@ module Aws::CloudDirectory
|
|
|
443
524
|
# operations.
|
|
444
525
|
#
|
|
445
526
|
# @option params [required, String] :directory_arn
|
|
446
|
-
# ARN associated with the Directory.
|
|
527
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory.
|
|
528
|
+
# For more information, see arns.
|
|
447
529
|
#
|
|
448
530
|
# @option params [required, Array<Types::BatchWriteOperation>] :operations
|
|
449
|
-
#
|
|
531
|
+
# A list of operations that are part of the batch.
|
|
450
532
|
#
|
|
451
533
|
# @return [Types::BatchWriteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
452
534
|
#
|
|
@@ -591,11 +673,11 @@ module Aws::CloudDirectory
|
|
|
591
673
|
# directory. A directory cannot be created without a schema.
|
|
592
674
|
#
|
|
593
675
|
# @option params [required, String] :name
|
|
594
|
-
#
|
|
676
|
+
# The name of the Directory. Should be unique per account, per region.
|
|
595
677
|
#
|
|
596
678
|
# @option params [required, String] :schema_arn
|
|
597
|
-
# ARN of the published schema that will be
|
|
598
|
-
# Directory. For more information, see arns.
|
|
679
|
+
# The Amazon Resource Name (ARN) of the published schema that will be
|
|
680
|
+
# copied into the data Directory. For more information, see arns.
|
|
599
681
|
#
|
|
600
682
|
# @return [Types::CreateDirectoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
601
683
|
#
|
|
@@ -631,25 +713,25 @@ module Aws::CloudDirectory
|
|
|
631
713
|
# development or applied schemas.
|
|
632
714
|
#
|
|
633
715
|
# @option params [required, String] :schema_arn
|
|
634
|
-
#
|
|
716
|
+
# The schema ARN in which the new Facet will be created. For more
|
|
635
717
|
# information, see arns.
|
|
636
718
|
#
|
|
637
719
|
# @option params [required, String] :name
|
|
638
|
-
#
|
|
720
|
+
# The name of the Facet, which is unique for a given schema.
|
|
639
721
|
#
|
|
640
722
|
# @option params [Array<Types::FacetAttribute>] :attributes
|
|
641
|
-
#
|
|
723
|
+
# The attributes that are associated with the Facet.
|
|
642
724
|
#
|
|
643
725
|
# @option params [required, String] :object_type
|
|
644
726
|
# Specifies whether a given object created from this facet is of type
|
|
645
|
-
#
|
|
727
|
+
# node, leaf node, policy or index.
|
|
646
728
|
#
|
|
647
729
|
# * Node: Can have multiple children but one parent.
|
|
648
730
|
#
|
|
649
731
|
# ^
|
|
650
732
|
# ^
|
|
651
733
|
#
|
|
652
|
-
# * Leaf
|
|
734
|
+
# * Leaf node: Cannot have children but can have multiple parents.
|
|
653
735
|
#
|
|
654
736
|
# ^
|
|
655
737
|
# ^
|
|
@@ -726,12 +808,12 @@ module Aws::CloudDirectory
|
|
|
726
808
|
# The ARN of the directory where the index should be created.
|
|
727
809
|
#
|
|
728
810
|
# @option params [required, Array<Types::AttributeKey>] :ordered_indexed_attribute_list
|
|
729
|
-
# Specifies the
|
|
811
|
+
# Specifies the attributes that should be indexed on. Currently only a
|
|
730
812
|
# single attribute is supported.
|
|
731
813
|
#
|
|
732
814
|
# @option params [required, Boolean] :is_unique
|
|
733
|
-
# Indicates whether
|
|
734
|
-
#
|
|
815
|
+
# Indicates whether the attribute that is being indexed has unique
|
|
816
|
+
# values or not.
|
|
735
817
|
#
|
|
736
818
|
# @option params [Types::ObjectReference] :parent_reference
|
|
737
819
|
# A reference to the parent object that contains the index object.
|
|
@@ -775,22 +857,22 @@ module Aws::CloudDirectory
|
|
|
775
857
|
end
|
|
776
858
|
|
|
777
859
|
# Creates an object in a Directory. Additionally attaches the object to
|
|
778
|
-
# a parent, if a parent reference and LinkName is specified. An object
|
|
860
|
+
# a parent, if a parent reference and `LinkName` is specified. An object
|
|
779
861
|
# is simply a collection of Facet attributes. You can also use this API
|
|
780
862
|
# call to create a policy object, if the facet from which you create the
|
|
781
863
|
# object is a policy facet.
|
|
782
864
|
#
|
|
783
865
|
# @option params [required, String] :directory_arn
|
|
784
|
-
#
|
|
785
|
-
# For more information, see arns.
|
|
866
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
867
|
+
# in which the object will be created. For more information, see arns.
|
|
786
868
|
#
|
|
787
869
|
# @option params [required, Array<Types::SchemaFacet>] :schema_facets
|
|
788
|
-
#
|
|
789
|
-
# information, see arns.
|
|
870
|
+
# A list of schema facets to be associated with the object that contains
|
|
871
|
+
# `SchemaArn` and facet name. For more information, see arns.
|
|
790
872
|
#
|
|
791
873
|
# @option params [Array<Types::AttributeKeyAndValue>] :object_attribute_list
|
|
792
|
-
#
|
|
793
|
-
# as the map value.
|
|
874
|
+
# The attribute map whose attribute ARN contains the key and attribute
|
|
875
|
+
# value as the map value.
|
|
794
876
|
#
|
|
795
877
|
# @option params [Types::ObjectReference] :parent_reference
|
|
796
878
|
# If specified, the parent reference to which this object will be
|
|
@@ -864,8 +946,8 @@ module Aws::CloudDirectory
|
|
|
864
946
|
# directories.
|
|
865
947
|
#
|
|
866
948
|
# @option params [required, String] :name
|
|
867
|
-
#
|
|
868
|
-
# each region.
|
|
949
|
+
# The name that is associated with the schema. This is unique to each
|
|
950
|
+
# account and in each region.
|
|
869
951
|
#
|
|
870
952
|
# @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
871
953
|
#
|
|
@@ -890,6 +972,63 @@ module Aws::CloudDirectory
|
|
|
890
972
|
req.send_request(options)
|
|
891
973
|
end
|
|
892
974
|
|
|
975
|
+
# Creates a TypedLinkFacet. For more information, see [Typed link][1].
|
|
976
|
+
#
|
|
977
|
+
#
|
|
978
|
+
#
|
|
979
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
980
|
+
#
|
|
981
|
+
# @option params [required, String] :schema_arn
|
|
982
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
983
|
+
# more information, see arns.
|
|
984
|
+
#
|
|
985
|
+
# @option params [required, Types::TypedLinkFacet] :facet
|
|
986
|
+
# Facet structure that is associated with the typed link facet.
|
|
987
|
+
#
|
|
988
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
989
|
+
#
|
|
990
|
+
# @example Request syntax with placeholder values
|
|
991
|
+
#
|
|
992
|
+
# resp = client.create_typed_link_facet({
|
|
993
|
+
# schema_arn: "Arn", # required
|
|
994
|
+
# facet: { # required
|
|
995
|
+
# name: "TypedLinkName", # required
|
|
996
|
+
# attributes: [ # required
|
|
997
|
+
# {
|
|
998
|
+
# name: "AttributeName", # required
|
|
999
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
|
1000
|
+
# default_value: {
|
|
1001
|
+
# string_value: "StringAttributeValue",
|
|
1002
|
+
# binary_value: "data",
|
|
1003
|
+
# boolean_value: false,
|
|
1004
|
+
# number_value: "NumberAttributeValue",
|
|
1005
|
+
# datetime_value: Time.now,
|
|
1006
|
+
# },
|
|
1007
|
+
# is_immutable: false,
|
|
1008
|
+
# rules: {
|
|
1009
|
+
# "RuleKey" => {
|
|
1010
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
|
1011
|
+
# parameters: {
|
|
1012
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
|
1013
|
+
# },
|
|
1014
|
+
# },
|
|
1015
|
+
# },
|
|
1016
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
|
1017
|
+
# },
|
|
1018
|
+
# ],
|
|
1019
|
+
# identity_attribute_order: ["AttributeName"], # required
|
|
1020
|
+
# },
|
|
1021
|
+
# })
|
|
1022
|
+
#
|
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateTypedLinkFacet AWS API Documentation
|
|
1024
|
+
#
|
|
1025
|
+
# @overload create_typed_link_facet(params = {})
|
|
1026
|
+
# @param [Hash] params ({})
|
|
1027
|
+
def create_typed_link_facet(params = {}, options = {})
|
|
1028
|
+
req = build_request(:create_typed_link_facet, params)
|
|
1029
|
+
req.send_request(options)
|
|
1030
|
+
end
|
|
1031
|
+
|
|
893
1032
|
# Deletes a directory. Only disabled directories can be deleted. A
|
|
894
1033
|
# deleted directory cannot be undone. Exercise extreme caution when
|
|
895
1034
|
# deleting directories.
|
|
@@ -920,12 +1059,13 @@ module Aws::CloudDirectory
|
|
|
920
1059
|
req.send_request(options)
|
|
921
1060
|
end
|
|
922
1061
|
|
|
923
|
-
# Deletes a given Facet. All attributes and Rules
|
|
924
|
-
# facet will be deleted. Only development schema facets are
|
|
925
|
-
# deletion.
|
|
1062
|
+
# Deletes a given Facet. All attributes and Rules that are associated
|
|
1063
|
+
# with the facet will be deleted. Only development schema facets are
|
|
1064
|
+
# allowed deletion.
|
|
926
1065
|
#
|
|
927
1066
|
# @option params [required, String] :schema_arn
|
|
928
|
-
# ARN associated with the Facet. For
|
|
1067
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet. For
|
|
1068
|
+
# more information, see arns.
|
|
929
1069
|
#
|
|
930
1070
|
# @option params [required, String] :name
|
|
931
1071
|
# The name of the facet to delete.
|
|
@@ -952,11 +1092,11 @@ module Aws::CloudDirectory
|
|
|
952
1092
|
# children and no parents can be deleted.
|
|
953
1093
|
#
|
|
954
1094
|
# @option params [required, String] :directory_arn
|
|
955
|
-
#
|
|
956
|
-
# information, see arns.
|
|
1095
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
1096
|
+
# where the object resides. For more information, see arns.
|
|
957
1097
|
#
|
|
958
1098
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
959
|
-
#
|
|
1099
|
+
# A reference that identifies the object.
|
|
960
1100
|
#
|
|
961
1101
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
962
1102
|
#
|
|
@@ -982,7 +1122,8 @@ module Aws::CloudDirectory
|
|
|
982
1122
|
# can only be deleted.
|
|
983
1123
|
#
|
|
984
1124
|
# @option params [required, String] :schema_arn
|
|
985
|
-
# ARN of the development schema. For more
|
|
1125
|
+
# The Amazon Resource Name (ARN) of the development schema. For more
|
|
1126
|
+
# information, see arns.
|
|
986
1127
|
#
|
|
987
1128
|
# @return [Types::DeleteSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
988
1129
|
#
|
|
@@ -1007,10 +1148,42 @@ module Aws::CloudDirectory
|
|
|
1007
1148
|
req.send_request(options)
|
|
1008
1149
|
end
|
|
1009
1150
|
|
|
1151
|
+
# Deletes a TypedLinkFacet. For more information, see [Typed link][1].
|
|
1152
|
+
#
|
|
1153
|
+
#
|
|
1154
|
+
#
|
|
1155
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
1156
|
+
#
|
|
1157
|
+
# @option params [required, String] :schema_arn
|
|
1158
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
1159
|
+
# more information, see arns.
|
|
1160
|
+
#
|
|
1161
|
+
# @option params [required, String] :name
|
|
1162
|
+
# The unique name of the typed link facet.
|
|
1163
|
+
#
|
|
1164
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1165
|
+
#
|
|
1166
|
+
# @example Request syntax with placeholder values
|
|
1167
|
+
#
|
|
1168
|
+
# resp = client.delete_typed_link_facet({
|
|
1169
|
+
# schema_arn: "Arn", # required
|
|
1170
|
+
# name: "TypedLinkName", # required
|
|
1171
|
+
# })
|
|
1172
|
+
#
|
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteTypedLinkFacet AWS API Documentation
|
|
1174
|
+
#
|
|
1175
|
+
# @overload delete_typed_link_facet(params = {})
|
|
1176
|
+
# @param [Hash] params ({})
|
|
1177
|
+
def delete_typed_link_facet(params = {}, options = {})
|
|
1178
|
+
req = build_request(:delete_typed_link_facet, params)
|
|
1179
|
+
req.send_request(options)
|
|
1180
|
+
end
|
|
1181
|
+
|
|
1010
1182
|
# Detaches the specified object from the specified index.
|
|
1011
1183
|
#
|
|
1012
1184
|
# @option params [required, String] :directory_arn
|
|
1013
|
-
# The ARN of the directory the index and object
|
|
1185
|
+
# The Amazon Resource Name (ARN) of the directory the index and object
|
|
1186
|
+
# exist in.
|
|
1014
1187
|
#
|
|
1015
1188
|
# @option params [required, Types::ObjectReference] :index_reference
|
|
1016
1189
|
# A reference to the index object.
|
|
@@ -1051,15 +1224,15 @@ module Aws::CloudDirectory
|
|
|
1051
1224
|
# be detached from the parent is specified by the link name.
|
|
1052
1225
|
#
|
|
1053
1226
|
# @option params [required, String] :directory_arn
|
|
1054
|
-
# ARN associated with the Directory
|
|
1055
|
-
# information, see arns.
|
|
1227
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
1228
|
+
# where objects reside. For more information, see arns.
|
|
1056
1229
|
#
|
|
1057
1230
|
# @option params [required, Types::ObjectReference] :parent_reference
|
|
1058
|
-
#
|
|
1059
|
-
# detached.
|
|
1231
|
+
# The parent reference from which the object with the specified link
|
|
1232
|
+
# name is detached.
|
|
1060
1233
|
#
|
|
1061
1234
|
# @option params [required, String] :link_name
|
|
1062
|
-
#
|
|
1235
|
+
# The link name associated with the object that needs to be detached.
|
|
1063
1236
|
#
|
|
1064
1237
|
# @return [Types::DetachObjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1065
1238
|
#
|
|
@@ -1091,8 +1264,8 @@ module Aws::CloudDirectory
|
|
|
1091
1264
|
# Detaches a policy from an object.
|
|
1092
1265
|
#
|
|
1093
1266
|
# @option params [required, String] :directory_arn
|
|
1094
|
-
#
|
|
1095
|
-
# information, see arns.
|
|
1267
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
1268
|
+
# where both objects reside. For more information, see arns.
|
|
1096
1269
|
#
|
|
1097
1270
|
# @option params [required, Types::ObjectReference] :policy_reference
|
|
1098
1271
|
# Reference that identifies the policy object.
|
|
@@ -1124,6 +1297,61 @@ module Aws::CloudDirectory
|
|
|
1124
1297
|
req.send_request(options)
|
|
1125
1298
|
end
|
|
1126
1299
|
|
|
1300
|
+
# Detaches a typed link from a specified source and target object. For
|
|
1301
|
+
# more information, see [Typed link][1].
|
|
1302
|
+
#
|
|
1303
|
+
#
|
|
1304
|
+
#
|
|
1305
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
1306
|
+
#
|
|
1307
|
+
# @option params [required, String] :directory_arn
|
|
1308
|
+
# The Amazon Resource Name (ARN) of the directory where you want to
|
|
1309
|
+
# detach the typed link.
|
|
1310
|
+
#
|
|
1311
|
+
# @option params [required, Types::TypedLinkSpecifier] :typed_link_specifier
|
|
1312
|
+
# Used to accept a typed link specifier as input.
|
|
1313
|
+
#
|
|
1314
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1315
|
+
#
|
|
1316
|
+
# @example Request syntax with placeholder values
|
|
1317
|
+
#
|
|
1318
|
+
# resp = client.detach_typed_link({
|
|
1319
|
+
# directory_arn: "Arn", # required
|
|
1320
|
+
# typed_link_specifier: { # required
|
|
1321
|
+
# typed_link_facet: { # required
|
|
1322
|
+
# schema_arn: "Arn", # required
|
|
1323
|
+
# typed_link_name: "TypedLinkName", # required
|
|
1324
|
+
# },
|
|
1325
|
+
# source_object_reference: { # required
|
|
1326
|
+
# selector: "SelectorObjectReference",
|
|
1327
|
+
# },
|
|
1328
|
+
# target_object_reference: { # required
|
|
1329
|
+
# selector: "SelectorObjectReference",
|
|
1330
|
+
# },
|
|
1331
|
+
# identity_attribute_values: [ # required
|
|
1332
|
+
# {
|
|
1333
|
+
# attribute_name: "AttributeName", # required
|
|
1334
|
+
# value: { # required
|
|
1335
|
+
# string_value: "StringAttributeValue",
|
|
1336
|
+
# binary_value: "data",
|
|
1337
|
+
# boolean_value: false,
|
|
1338
|
+
# number_value: "NumberAttributeValue",
|
|
1339
|
+
# datetime_value: Time.now,
|
|
1340
|
+
# },
|
|
1341
|
+
# },
|
|
1342
|
+
# ],
|
|
1343
|
+
# },
|
|
1344
|
+
# })
|
|
1345
|
+
#
|
|
1346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachTypedLink AWS API Documentation
|
|
1347
|
+
#
|
|
1348
|
+
# @overload detach_typed_link(params = {})
|
|
1349
|
+
# @param [Hash] params ({})
|
|
1350
|
+
def detach_typed_link(params = {}, options = {})
|
|
1351
|
+
req = build_request(:detach_typed_link, params)
|
|
1352
|
+
req.send_request(options)
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1127
1355
|
# Disables the specified directory. Disabled directories cannot be read
|
|
1128
1356
|
# or written to. Only enabled directories can be disabled. Disabled
|
|
1129
1357
|
# directories may be reenabled.
|
|
@@ -1214,12 +1442,13 @@ module Aws::CloudDirectory
|
|
|
1214
1442
|
req.send_request(options)
|
|
1215
1443
|
end
|
|
1216
1444
|
|
|
1217
|
-
# Gets details of the Facet, such as
|
|
1218
|
-
# ObjectType
|
|
1445
|
+
# Gets details of the Facet, such as facet name, attributes, Rules, or
|
|
1446
|
+
# `ObjectType`. You can call this on all kinds of schema facets --
|
|
1219
1447
|
# published, development, or applied.
|
|
1220
1448
|
#
|
|
1221
1449
|
# @option params [required, String] :schema_arn
|
|
1222
|
-
# ARN associated with the Facet. For
|
|
1450
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet. For
|
|
1451
|
+
# more information, see arns.
|
|
1223
1452
|
#
|
|
1224
1453
|
# @option params [required, String] :name
|
|
1225
1454
|
# The name of the facet to retrieve.
|
|
@@ -1326,6 +1555,45 @@ module Aws::CloudDirectory
|
|
|
1326
1555
|
req.send_request(options)
|
|
1327
1556
|
end
|
|
1328
1557
|
|
|
1558
|
+
# Returns the identity attribute order for a specific TypedLinkFacet.
|
|
1559
|
+
# For more information, see [Typed link][1].
|
|
1560
|
+
#
|
|
1561
|
+
#
|
|
1562
|
+
#
|
|
1563
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
1564
|
+
#
|
|
1565
|
+
# @option params [required, String] :schema_arn
|
|
1566
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
1567
|
+
# more information, see arns.
|
|
1568
|
+
#
|
|
1569
|
+
# @option params [required, String] :name
|
|
1570
|
+
# The unique name of the typed link facet.
|
|
1571
|
+
#
|
|
1572
|
+
# @return [Types::GetTypedLinkFacetInformationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1573
|
+
#
|
|
1574
|
+
# * {Types::GetTypedLinkFacetInformationResponse#identity_attribute_order #identity_attribute_order} => Array<String>
|
|
1575
|
+
#
|
|
1576
|
+
# @example Request syntax with placeholder values
|
|
1577
|
+
#
|
|
1578
|
+
# resp = client.get_typed_link_facet_information({
|
|
1579
|
+
# schema_arn: "Arn", # required
|
|
1580
|
+
# name: "TypedLinkName", # required
|
|
1581
|
+
# })
|
|
1582
|
+
#
|
|
1583
|
+
# @example Response structure
|
|
1584
|
+
#
|
|
1585
|
+
# resp.identity_attribute_order #=> Array
|
|
1586
|
+
# resp.identity_attribute_order[0] #=> String
|
|
1587
|
+
#
|
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetTypedLinkFacetInformation AWS API Documentation
|
|
1589
|
+
#
|
|
1590
|
+
# @overload get_typed_link_facet_information(params = {})
|
|
1591
|
+
# @param [Hash] params ({})
|
|
1592
|
+
def get_typed_link_facet_information(params = {}, options = {})
|
|
1593
|
+
req = build_request(:get_typed_link_facet_information, params)
|
|
1594
|
+
req.send_request(options)
|
|
1595
|
+
end
|
|
1596
|
+
|
|
1329
1597
|
# Lists schemas applied to a directory.
|
|
1330
1598
|
#
|
|
1331
1599
|
# @option params [required, String] :directory_arn
|
|
@@ -1423,7 +1691,8 @@ module Aws::CloudDirectory
|
|
|
1423
1691
|
req.send_request(options)
|
|
1424
1692
|
end
|
|
1425
1693
|
|
|
1426
|
-
# Retrieves
|
|
1694
|
+
# Retrieves each Amazon Resource Name (ARN) of schemas in the
|
|
1695
|
+
# development state.
|
|
1427
1696
|
#
|
|
1428
1697
|
# @option params [String] :next_token
|
|
1429
1698
|
# The pagination token.
|
|
@@ -1561,13 +1830,13 @@ module Aws::CloudDirectory
|
|
|
1561
1830
|
# Retrieves the names of facets that exist in a schema.
|
|
1562
1831
|
#
|
|
1563
1832
|
# @option params [required, String] :schema_arn
|
|
1564
|
-
# The ARN to retrieve facet names from.
|
|
1833
|
+
# The Amazon Resource Name (ARN) to retrieve facet names from.
|
|
1565
1834
|
#
|
|
1566
1835
|
# @option params [String] :next_token
|
|
1567
1836
|
# The pagination token.
|
|
1568
1837
|
#
|
|
1569
1838
|
# @option params [Integer] :max_results
|
|
1570
|
-
# The maximum number of results to retrieve
|
|
1839
|
+
# The maximum number of results to retrieve.
|
|
1571
1840
|
#
|
|
1572
1841
|
# @return [Types::ListFacetNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1573
1842
|
#
|
|
@@ -1597,6 +1866,110 @@ module Aws::CloudDirectory
|
|
|
1597
1866
|
req.send_request(options)
|
|
1598
1867
|
end
|
|
1599
1868
|
|
|
1869
|
+
# Returns a paginated list of all the incoming TypedLinkSpecifier
|
|
1870
|
+
# information for an object. It also supports filtering by typed link
|
|
1871
|
+
# facet and identity attributes. For more information, see [Typed
|
|
1872
|
+
# link][1].
|
|
1873
|
+
#
|
|
1874
|
+
#
|
|
1875
|
+
#
|
|
1876
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
1877
|
+
#
|
|
1878
|
+
# @option params [required, String] :directory_arn
|
|
1879
|
+
# The Amazon Resource Name (ARN) of the directory where you want to list
|
|
1880
|
+
# the typed links.
|
|
1881
|
+
#
|
|
1882
|
+
# @option params [required, Types::ObjectReference] :object_reference
|
|
1883
|
+
# Reference that identifies the object whose attributes will be listed.
|
|
1884
|
+
#
|
|
1885
|
+
# @option params [Array<Types::TypedLinkAttributeRange>] :filter_attribute_ranges
|
|
1886
|
+
# Provides range filters for multiple attributes. When providing ranges
|
|
1887
|
+
# to typed link selection, any inexact ranges must be specified at the
|
|
1888
|
+
# end. Any attributes that do not have a range specified are presumed to
|
|
1889
|
+
# match the entire range.
|
|
1890
|
+
#
|
|
1891
|
+
# @option params [Types::TypedLinkSchemaAndFacetName] :filter_typed_link
|
|
1892
|
+
# Filters are interpreted in the order of the attributes on the typed
|
|
1893
|
+
# link facet, not the order in which they are supplied to any API calls.
|
|
1894
|
+
#
|
|
1895
|
+
# @option params [String] :next_token
|
|
1896
|
+
# The pagination token.
|
|
1897
|
+
#
|
|
1898
|
+
# @option params [Integer] :max_results
|
|
1899
|
+
# The maximum number of results to retrieve.
|
|
1900
|
+
#
|
|
1901
|
+
# @option params [String] :consistency_level
|
|
1902
|
+
# The consistency level to execute the request at.
|
|
1903
|
+
#
|
|
1904
|
+
# @return [Types::ListIncomingTypedLinksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1905
|
+
#
|
|
1906
|
+
# * {Types::ListIncomingTypedLinksResponse#link_specifiers #link_specifiers} => Array<Types::TypedLinkSpecifier>
|
|
1907
|
+
# * {Types::ListIncomingTypedLinksResponse#next_token #next_token} => String
|
|
1908
|
+
#
|
|
1909
|
+
# @example Request syntax with placeholder values
|
|
1910
|
+
#
|
|
1911
|
+
# resp = client.list_incoming_typed_links({
|
|
1912
|
+
# directory_arn: "Arn", # required
|
|
1913
|
+
# object_reference: { # required
|
|
1914
|
+
# selector: "SelectorObjectReference",
|
|
1915
|
+
# },
|
|
1916
|
+
# filter_attribute_ranges: [
|
|
1917
|
+
# {
|
|
1918
|
+
# attribute_name: "AttributeName",
|
|
1919
|
+
# range: { # required
|
|
1920
|
+
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
|
1921
|
+
# start_value: {
|
|
1922
|
+
# string_value: "StringAttributeValue",
|
|
1923
|
+
# binary_value: "data",
|
|
1924
|
+
# boolean_value: false,
|
|
1925
|
+
# number_value: "NumberAttributeValue",
|
|
1926
|
+
# datetime_value: Time.now,
|
|
1927
|
+
# },
|
|
1928
|
+
# end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
|
1929
|
+
# end_value: {
|
|
1930
|
+
# string_value: "StringAttributeValue",
|
|
1931
|
+
# binary_value: "data",
|
|
1932
|
+
# boolean_value: false,
|
|
1933
|
+
# number_value: "NumberAttributeValue",
|
|
1934
|
+
# datetime_value: Time.now,
|
|
1935
|
+
# },
|
|
1936
|
+
# },
|
|
1937
|
+
# },
|
|
1938
|
+
# ],
|
|
1939
|
+
# filter_typed_link: {
|
|
1940
|
+
# schema_arn: "Arn", # required
|
|
1941
|
+
# typed_link_name: "TypedLinkName", # required
|
|
1942
|
+
# },
|
|
1943
|
+
# next_token: "NextToken",
|
|
1944
|
+
# max_results: 1,
|
|
1945
|
+
# consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
|
|
1946
|
+
# })
|
|
1947
|
+
#
|
|
1948
|
+
# @example Response structure
|
|
1949
|
+
#
|
|
1950
|
+
# resp.link_specifiers #=> Array
|
|
1951
|
+
# resp.link_specifiers[0].typed_link_facet.schema_arn #=> String
|
|
1952
|
+
# resp.link_specifiers[0].typed_link_facet.typed_link_name #=> String
|
|
1953
|
+
# resp.link_specifiers[0].source_object_reference.selector #=> String
|
|
1954
|
+
# resp.link_specifiers[0].target_object_reference.selector #=> String
|
|
1955
|
+
# resp.link_specifiers[0].identity_attribute_values #=> Array
|
|
1956
|
+
# resp.link_specifiers[0].identity_attribute_values[0].attribute_name #=> String
|
|
1957
|
+
# resp.link_specifiers[0].identity_attribute_values[0].value.string_value #=> String
|
|
1958
|
+
# resp.link_specifiers[0].identity_attribute_values[0].value.binary_value #=> String
|
|
1959
|
+
# resp.link_specifiers[0].identity_attribute_values[0].value.boolean_value #=> Boolean
|
|
1960
|
+
# resp.link_specifiers[0].identity_attribute_values[0].value.number_value #=> String
|
|
1961
|
+
# resp.link_specifiers[0].identity_attribute_values[0].value.datetime_value #=> Time
|
|
1962
|
+
# resp.next_token #=> String
|
|
1963
|
+
#
|
|
1964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIncomingTypedLinks AWS API Documentation
|
|
1965
|
+
#
|
|
1966
|
+
# @overload list_incoming_typed_links(params = {})
|
|
1967
|
+
# @param [Hash] params ({})
|
|
1968
|
+
def list_incoming_typed_links(params = {}, options = {})
|
|
1969
|
+
req = build_request(:list_incoming_typed_links, params)
|
|
1970
|
+
req.send_request(options)
|
|
1971
|
+
end
|
|
1972
|
+
|
|
1600
1973
|
# Lists objects attached to the specified index.
|
|
1601
1974
|
#
|
|
1602
1975
|
# @option params [required, String] :directory_arn
|
|
@@ -1685,21 +2058,22 @@ module Aws::CloudDirectory
|
|
|
1685
2058
|
req.send_request(options)
|
|
1686
2059
|
end
|
|
1687
2060
|
|
|
1688
|
-
# Lists all attributes associated with an object.
|
|
2061
|
+
# Lists all attributes that are associated with an object.
|
|
1689
2062
|
#
|
|
1690
2063
|
# @option params [required, String] :directory_arn
|
|
1691
|
-
#
|
|
1692
|
-
# information, see arns.
|
|
2064
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
2065
|
+
# where the object resides. For more information, see arns.
|
|
1693
2066
|
#
|
|
1694
2067
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
1695
|
-
#
|
|
2068
|
+
# The reference that identifies the object whose attributes will be
|
|
2069
|
+
# listed.
|
|
1696
2070
|
#
|
|
1697
2071
|
# @option params [String] :next_token
|
|
1698
2072
|
# The pagination token.
|
|
1699
2073
|
#
|
|
1700
2074
|
# @option params [Integer] :max_results
|
|
1701
|
-
#
|
|
1702
|
-
# approximate number.
|
|
2075
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2076
|
+
# an approximate number.
|
|
1703
2077
|
#
|
|
1704
2078
|
# @option params [String] :consistency_level
|
|
1705
2079
|
# Represents the manner and timing in which the successful write or
|
|
@@ -1707,8 +2081,8 @@ module Aws::CloudDirectory
|
|
|
1707
2081
|
# that same object.
|
|
1708
2082
|
#
|
|
1709
2083
|
# @option params [Types::SchemaFacet] :facet_filter
|
|
1710
|
-
# Used to filter the list of object attributes associated with
|
|
1711
|
-
# facet.
|
|
2084
|
+
# Used to filter the list of object attributes that are associated with
|
|
2085
|
+
# a certain facet.
|
|
1712
2086
|
#
|
|
1713
2087
|
# @return [Types::ListObjectAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1714
2088
|
#
|
|
@@ -1753,23 +2127,23 @@ module Aws::CloudDirectory
|
|
|
1753
2127
|
req.send_request(options)
|
|
1754
2128
|
end
|
|
1755
2129
|
|
|
1756
|
-
# Returns a paginated list of child objects associated with a
|
|
1757
|
-
# object.
|
|
2130
|
+
# Returns a paginated list of child objects that are associated with a
|
|
2131
|
+
# given object.
|
|
1758
2132
|
#
|
|
1759
2133
|
# @option params [required, String] :directory_arn
|
|
1760
|
-
#
|
|
1761
|
-
# information, see arns.
|
|
2134
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
2135
|
+
# where the object resides. For more information, see arns.
|
|
1762
2136
|
#
|
|
1763
2137
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
1764
|
-
#
|
|
1765
|
-
# listed.
|
|
2138
|
+
# The reference that identifies the object for which child objects are
|
|
2139
|
+
# being listed.
|
|
1766
2140
|
#
|
|
1767
2141
|
# @option params [String] :next_token
|
|
1768
2142
|
# The pagination token.
|
|
1769
2143
|
#
|
|
1770
2144
|
# @option params [Integer] :max_results
|
|
1771
|
-
#
|
|
1772
|
-
# approximate number.
|
|
2145
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2146
|
+
# an approximate number.
|
|
1773
2147
|
#
|
|
1774
2148
|
# @option params [String] :consistency_level
|
|
1775
2149
|
# Represents the manner and timing in which the successful write or
|
|
@@ -1818,7 +2192,7 @@ module Aws::CloudDirectory
|
|
|
1818
2192
|
# `MaxResults`, in case there are multiple paths to the parent. The
|
|
1819
2193
|
# order of the paths and nodes returned is consistent among multiple API
|
|
1820
2194
|
# calls unless the objects are deleted or moved. Paths not leading to
|
|
1821
|
-
# directory root are ignored from the target object.
|
|
2195
|
+
# the directory root are ignored from the target object.
|
|
1822
2196
|
#
|
|
1823
2197
|
#
|
|
1824
2198
|
#
|
|
@@ -1828,14 +2202,15 @@ module Aws::CloudDirectory
|
|
|
1828
2202
|
# The ARN of the directory to which the parent path applies.
|
|
1829
2203
|
#
|
|
1830
2204
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
1831
|
-
#
|
|
2205
|
+
# The reference that identifies the object whose parent paths are
|
|
2206
|
+
# listed.
|
|
1832
2207
|
#
|
|
1833
2208
|
# @option params [String] :next_token
|
|
1834
2209
|
# The pagination token.
|
|
1835
2210
|
#
|
|
1836
2211
|
# @option params [Integer] :max_results
|
|
1837
|
-
#
|
|
1838
|
-
# approximate number.
|
|
2212
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2213
|
+
# an approximate number.
|
|
1839
2214
|
#
|
|
1840
2215
|
# @return [Types::ListObjectParentPathsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1841
2216
|
#
|
|
@@ -1870,23 +2245,23 @@ module Aws::CloudDirectory
|
|
|
1870
2245
|
req.send_request(options)
|
|
1871
2246
|
end
|
|
1872
2247
|
|
|
1873
|
-
# Lists parent objects associated with a given object in
|
|
1874
|
-
# fashion.
|
|
2248
|
+
# Lists parent objects that are associated with a given object in
|
|
2249
|
+
# pagination fashion.
|
|
1875
2250
|
#
|
|
1876
2251
|
# @option params [required, String] :directory_arn
|
|
1877
|
-
#
|
|
1878
|
-
# information, see arns.
|
|
2252
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
2253
|
+
# where the object resides. For more information, see arns.
|
|
1879
2254
|
#
|
|
1880
2255
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
1881
|
-
#
|
|
2256
|
+
# The reference that identifies the object for which parent objects are
|
|
1882
2257
|
# being listed.
|
|
1883
2258
|
#
|
|
1884
2259
|
# @option params [String] :next_token
|
|
1885
2260
|
# The pagination token.
|
|
1886
2261
|
#
|
|
1887
2262
|
# @option params [Integer] :max_results
|
|
1888
|
-
#
|
|
1889
|
-
# approximate number.
|
|
2263
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2264
|
+
# an approximate number.
|
|
1890
2265
|
#
|
|
1891
2266
|
# @option params [String] :consistency_level
|
|
1892
2267
|
# Represents the manner and timing in which the successful write or
|
|
@@ -1928,8 +2303,8 @@ module Aws::CloudDirectory
|
|
|
1928
2303
|
# Returns policies attached to an object in pagination fashion.
|
|
1929
2304
|
#
|
|
1930
2305
|
# @option params [required, String] :directory_arn
|
|
1931
|
-
# ARN associated with the Directory
|
|
1932
|
-
# information, see arns.
|
|
2306
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
2307
|
+
# where objects reside. For more information, see arns.
|
|
1933
2308
|
#
|
|
1934
2309
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
1935
2310
|
# Reference that identifies the object for which policies will be
|
|
@@ -1939,8 +2314,8 @@ module Aws::CloudDirectory
|
|
|
1939
2314
|
# The pagination token.
|
|
1940
2315
|
#
|
|
1941
2316
|
# @option params [Integer] :max_results
|
|
1942
|
-
#
|
|
1943
|
-
# approximate number.
|
|
2317
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2318
|
+
# an approximate number.
|
|
1944
2319
|
#
|
|
1945
2320
|
# @option params [String] :consistency_level
|
|
1946
2321
|
# Represents the manner and timing in which the successful write or
|
|
@@ -1979,22 +2354,127 @@ module Aws::CloudDirectory
|
|
|
1979
2354
|
req.send_request(options)
|
|
1980
2355
|
end
|
|
1981
2356
|
|
|
2357
|
+
# Returns a paginated list of all the outgoing TypedLinkSpecifier
|
|
2358
|
+
# information for an object. It also supports filtering by typed link
|
|
2359
|
+
# facet and identity attributes. For more information, see [Typed
|
|
2360
|
+
# link][1].
|
|
2361
|
+
#
|
|
2362
|
+
#
|
|
2363
|
+
#
|
|
2364
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
2365
|
+
#
|
|
2366
|
+
# @option params [required, String] :directory_arn
|
|
2367
|
+
# The Amazon Resource Name (ARN) of the directory where you want to list
|
|
2368
|
+
# the typed links.
|
|
2369
|
+
#
|
|
2370
|
+
# @option params [required, Types::ObjectReference] :object_reference
|
|
2371
|
+
# A reference that identifies the object whose attributes will be
|
|
2372
|
+
# listed.
|
|
2373
|
+
#
|
|
2374
|
+
# @option params [Array<Types::TypedLinkAttributeRange>] :filter_attribute_ranges
|
|
2375
|
+
# Provides range filters for multiple attributes. When providing ranges
|
|
2376
|
+
# to typed link selection, any inexact ranges must be specified at the
|
|
2377
|
+
# end. Any attributes that do not have a range specified are presumed to
|
|
2378
|
+
# match the entire range.
|
|
2379
|
+
#
|
|
2380
|
+
# @option params [Types::TypedLinkSchemaAndFacetName] :filter_typed_link
|
|
2381
|
+
# Filters are interpreted in the order of the attributes defined on the
|
|
2382
|
+
# typed link facet, not the order they are supplied to any API calls.
|
|
2383
|
+
#
|
|
2384
|
+
# @option params [String] :next_token
|
|
2385
|
+
# The pagination token.
|
|
2386
|
+
#
|
|
2387
|
+
# @option params [Integer] :max_results
|
|
2388
|
+
# The maximum number of results to retrieve.
|
|
2389
|
+
#
|
|
2390
|
+
# @option params [String] :consistency_level
|
|
2391
|
+
# The consistency level to execute the request at.
|
|
2392
|
+
#
|
|
2393
|
+
# @return [Types::ListOutgoingTypedLinksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2394
|
+
#
|
|
2395
|
+
# * {Types::ListOutgoingTypedLinksResponse#typed_link_specifiers #typed_link_specifiers} => Array<Types::TypedLinkSpecifier>
|
|
2396
|
+
# * {Types::ListOutgoingTypedLinksResponse#next_token #next_token} => String
|
|
2397
|
+
#
|
|
2398
|
+
# @example Request syntax with placeholder values
|
|
2399
|
+
#
|
|
2400
|
+
# resp = client.list_outgoing_typed_links({
|
|
2401
|
+
# directory_arn: "Arn", # required
|
|
2402
|
+
# object_reference: { # required
|
|
2403
|
+
# selector: "SelectorObjectReference",
|
|
2404
|
+
# },
|
|
2405
|
+
# filter_attribute_ranges: [
|
|
2406
|
+
# {
|
|
2407
|
+
# attribute_name: "AttributeName",
|
|
2408
|
+
# range: { # required
|
|
2409
|
+
# start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
|
2410
|
+
# start_value: {
|
|
2411
|
+
# string_value: "StringAttributeValue",
|
|
2412
|
+
# binary_value: "data",
|
|
2413
|
+
# boolean_value: false,
|
|
2414
|
+
# number_value: "NumberAttributeValue",
|
|
2415
|
+
# datetime_value: Time.now,
|
|
2416
|
+
# },
|
|
2417
|
+
# end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
|
|
2418
|
+
# end_value: {
|
|
2419
|
+
# string_value: "StringAttributeValue",
|
|
2420
|
+
# binary_value: "data",
|
|
2421
|
+
# boolean_value: false,
|
|
2422
|
+
# number_value: "NumberAttributeValue",
|
|
2423
|
+
# datetime_value: Time.now,
|
|
2424
|
+
# },
|
|
2425
|
+
# },
|
|
2426
|
+
# },
|
|
2427
|
+
# ],
|
|
2428
|
+
# filter_typed_link: {
|
|
2429
|
+
# schema_arn: "Arn", # required
|
|
2430
|
+
# typed_link_name: "TypedLinkName", # required
|
|
2431
|
+
# },
|
|
2432
|
+
# next_token: "NextToken",
|
|
2433
|
+
# max_results: 1,
|
|
2434
|
+
# consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
|
|
2435
|
+
# })
|
|
2436
|
+
#
|
|
2437
|
+
# @example Response structure
|
|
2438
|
+
#
|
|
2439
|
+
# resp.typed_link_specifiers #=> Array
|
|
2440
|
+
# resp.typed_link_specifiers[0].typed_link_facet.schema_arn #=> String
|
|
2441
|
+
# resp.typed_link_specifiers[0].typed_link_facet.typed_link_name #=> String
|
|
2442
|
+
# resp.typed_link_specifiers[0].source_object_reference.selector #=> String
|
|
2443
|
+
# resp.typed_link_specifiers[0].target_object_reference.selector #=> String
|
|
2444
|
+
# resp.typed_link_specifiers[0].identity_attribute_values #=> Array
|
|
2445
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].attribute_name #=> String
|
|
2446
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].value.string_value #=> String
|
|
2447
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].value.binary_value #=> String
|
|
2448
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].value.boolean_value #=> Boolean
|
|
2449
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].value.number_value #=> String
|
|
2450
|
+
# resp.typed_link_specifiers[0].identity_attribute_values[0].value.datetime_value #=> Time
|
|
2451
|
+
# resp.next_token #=> String
|
|
2452
|
+
#
|
|
2453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListOutgoingTypedLinks AWS API Documentation
|
|
2454
|
+
#
|
|
2455
|
+
# @overload list_outgoing_typed_links(params = {})
|
|
2456
|
+
# @param [Hash] params ({})
|
|
2457
|
+
def list_outgoing_typed_links(params = {}, options = {})
|
|
2458
|
+
req = build_request(:list_outgoing_typed_links, params)
|
|
2459
|
+
req.send_request(options)
|
|
2460
|
+
end
|
|
2461
|
+
|
|
1982
2462
|
# Returns all of the `ObjectIdentifiers` to which a given policy is
|
|
1983
2463
|
# attached.
|
|
1984
2464
|
#
|
|
1985
2465
|
# @option params [required, String] :directory_arn
|
|
1986
|
-
# ARN associated with the Directory
|
|
1987
|
-
# information, see arns.
|
|
2466
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
2467
|
+
# where objects reside. For more information, see arns.
|
|
1988
2468
|
#
|
|
1989
2469
|
# @option params [required, Types::ObjectReference] :policy_reference
|
|
1990
|
-
#
|
|
2470
|
+
# The reference that identifies the policy object.
|
|
1991
2471
|
#
|
|
1992
2472
|
# @option params [String] :next_token
|
|
1993
2473
|
# The pagination token.
|
|
1994
2474
|
#
|
|
1995
2475
|
# @option params [Integer] :max_results
|
|
1996
|
-
#
|
|
1997
|
-
# approximate number.
|
|
2476
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2477
|
+
# an approximate number.
|
|
1998
2478
|
#
|
|
1999
2479
|
# @option params [String] :consistency_level
|
|
2000
2480
|
# Represents the manner and timing in which the successful write or
|
|
@@ -2033,7 +2513,7 @@ module Aws::CloudDirectory
|
|
|
2033
2513
|
req.send_request(options)
|
|
2034
2514
|
end
|
|
2035
2515
|
|
|
2036
|
-
# Retrieves published schema
|
|
2516
|
+
# Retrieves each published schema Amazon Resource Name (ARN).
|
|
2037
2517
|
#
|
|
2038
2518
|
# @option params [String] :next_token
|
|
2039
2519
|
# The pagination token.
|
|
@@ -2073,14 +2553,15 @@ module Aws::CloudDirectory
|
|
|
2073
2553
|
# returned for a given directory with this API call.
|
|
2074
2554
|
#
|
|
2075
2555
|
# @option params [required, String] :resource_arn
|
|
2076
|
-
# ARN of the resource. Tagging is only
|
|
2556
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
|
2557
|
+
# supported for directories.
|
|
2077
2558
|
#
|
|
2078
2559
|
# @option params [String] :next_token
|
|
2079
2560
|
# The pagination token. This is for future use. Currently pagination is
|
|
2080
2561
|
# not supported for tagging.
|
|
2081
2562
|
#
|
|
2082
2563
|
# @option params [Integer] :max_results
|
|
2083
|
-
# The MaxResults parameter sets the maximum number of results returned
|
|
2564
|
+
# The `MaxResults` parameter sets the maximum number of results returned
|
|
2084
2565
|
# in a single page. This is for future use and is not supported
|
|
2085
2566
|
# currently.
|
|
2086
2567
|
#
|
|
@@ -2113,16 +2594,127 @@ module Aws::CloudDirectory
|
|
|
2113
2594
|
req.send_request(options)
|
|
2114
2595
|
end
|
|
2115
2596
|
|
|
2597
|
+
# Returns a paginated list of all attribute definitions for a particular
|
|
2598
|
+
# TypedLinkFacet. For more information, see [Typed link][1].
|
|
2599
|
+
#
|
|
2600
|
+
#
|
|
2601
|
+
#
|
|
2602
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
2603
|
+
#
|
|
2604
|
+
# @option params [required, String] :schema_arn
|
|
2605
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
2606
|
+
# more information, see arns.
|
|
2607
|
+
#
|
|
2608
|
+
# @option params [required, String] :name
|
|
2609
|
+
# The unique name of the typed link facet.
|
|
2610
|
+
#
|
|
2611
|
+
# @option params [String] :next_token
|
|
2612
|
+
# The pagination token.
|
|
2613
|
+
#
|
|
2614
|
+
# @option params [Integer] :max_results
|
|
2615
|
+
# The maximum number of results to retrieve.
|
|
2616
|
+
#
|
|
2617
|
+
# @return [Types::ListTypedLinkFacetAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2618
|
+
#
|
|
2619
|
+
# * {Types::ListTypedLinkFacetAttributesResponse#attributes #attributes} => Array<Types::TypedLinkAttributeDefinition>
|
|
2620
|
+
# * {Types::ListTypedLinkFacetAttributesResponse#next_token #next_token} => String
|
|
2621
|
+
#
|
|
2622
|
+
# @example Request syntax with placeholder values
|
|
2623
|
+
#
|
|
2624
|
+
# resp = client.list_typed_link_facet_attributes({
|
|
2625
|
+
# schema_arn: "Arn", # required
|
|
2626
|
+
# name: "TypedLinkName", # required
|
|
2627
|
+
# next_token: "NextToken",
|
|
2628
|
+
# max_results: 1,
|
|
2629
|
+
# })
|
|
2630
|
+
#
|
|
2631
|
+
# @example Response structure
|
|
2632
|
+
#
|
|
2633
|
+
# resp.attributes #=> Array
|
|
2634
|
+
# resp.attributes[0].name #=> String
|
|
2635
|
+
# resp.attributes[0].type #=> String, one of "STRING", "BINARY", "BOOLEAN", "NUMBER", "DATETIME"
|
|
2636
|
+
# resp.attributes[0].default_value.string_value #=> String
|
|
2637
|
+
# resp.attributes[0].default_value.binary_value #=> String
|
|
2638
|
+
# resp.attributes[0].default_value.boolean_value #=> Boolean
|
|
2639
|
+
# resp.attributes[0].default_value.number_value #=> String
|
|
2640
|
+
# resp.attributes[0].default_value.datetime_value #=> Time
|
|
2641
|
+
# resp.attributes[0].is_immutable #=> Boolean
|
|
2642
|
+
# resp.attributes[0].rules #=> Hash
|
|
2643
|
+
# resp.attributes[0].rules["RuleKey"].type #=> String, one of "BINARY_LENGTH", "NUMBER_COMPARISON", "STRING_FROM_SET", "STRING_LENGTH"
|
|
2644
|
+
# resp.attributes[0].rules["RuleKey"].parameters #=> Hash
|
|
2645
|
+
# resp.attributes[0].rules["RuleKey"].parameters["RuleParameterKey"] #=> String
|
|
2646
|
+
# resp.attributes[0].required_behavior #=> String, one of "REQUIRED_ALWAYS", "NOT_REQUIRED"
|
|
2647
|
+
# resp.next_token #=> String
|
|
2648
|
+
#
|
|
2649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetAttributes AWS API Documentation
|
|
2650
|
+
#
|
|
2651
|
+
# @overload list_typed_link_facet_attributes(params = {})
|
|
2652
|
+
# @param [Hash] params ({})
|
|
2653
|
+
def list_typed_link_facet_attributes(params = {}, options = {})
|
|
2654
|
+
req = build_request(:list_typed_link_facet_attributes, params)
|
|
2655
|
+
req.send_request(options)
|
|
2656
|
+
end
|
|
2657
|
+
|
|
2658
|
+
# Returns a paginated list of `TypedLink` facet names for a particular
|
|
2659
|
+
# schema. For more information, see [Typed link][1].
|
|
2660
|
+
#
|
|
2661
|
+
#
|
|
2662
|
+
#
|
|
2663
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
2664
|
+
#
|
|
2665
|
+
# @option params [required, String] :schema_arn
|
|
2666
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
2667
|
+
# more information, see arns.
|
|
2668
|
+
#
|
|
2669
|
+
# @option params [String] :next_token
|
|
2670
|
+
# The pagination token.
|
|
2671
|
+
#
|
|
2672
|
+
# @option params [Integer] :max_results
|
|
2673
|
+
# The maximum number of results to retrieve.
|
|
2674
|
+
#
|
|
2675
|
+
# @return [Types::ListTypedLinkFacetNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2676
|
+
#
|
|
2677
|
+
# * {Types::ListTypedLinkFacetNamesResponse#facet_names #facet_names} => Array<String>
|
|
2678
|
+
# * {Types::ListTypedLinkFacetNamesResponse#next_token #next_token} => String
|
|
2679
|
+
#
|
|
2680
|
+
# @example Request syntax with placeholder values
|
|
2681
|
+
#
|
|
2682
|
+
# resp = client.list_typed_link_facet_names({
|
|
2683
|
+
# schema_arn: "Arn", # required
|
|
2684
|
+
# next_token: "NextToken",
|
|
2685
|
+
# max_results: 1,
|
|
2686
|
+
# })
|
|
2687
|
+
#
|
|
2688
|
+
# @example Response structure
|
|
2689
|
+
#
|
|
2690
|
+
# resp.facet_names #=> Array
|
|
2691
|
+
# resp.facet_names[0] #=> String
|
|
2692
|
+
# resp.next_token #=> String
|
|
2693
|
+
#
|
|
2694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTypedLinkFacetNames AWS API Documentation
|
|
2695
|
+
#
|
|
2696
|
+
# @overload list_typed_link_facet_names(params = {})
|
|
2697
|
+
# @param [Hash] params ({})
|
|
2698
|
+
def list_typed_link_facet_names(params = {}, options = {})
|
|
2699
|
+
req = build_request(:list_typed_link_facet_names, params)
|
|
2700
|
+
req.send_request(options)
|
|
2701
|
+
end
|
|
2702
|
+
|
|
2116
2703
|
# Lists all policies from the root of the Directory to the object
|
|
2117
2704
|
# specified. If there are no policies present, an empty list is
|
|
2118
2705
|
# returned. If policies are present, and if some objects don't have the
|
|
2119
2706
|
# policies attached, it returns the `ObjectIdentifier` for such objects.
|
|
2120
2707
|
# If policies are present, it returns `ObjectIdentifier`, `policyId`,
|
|
2121
2708
|
# and `policyType`. Paths that don't lead to the root from the target
|
|
2122
|
-
# object are ignored.
|
|
2709
|
+
# object are ignored. For more information, see [Policies][1].
|
|
2710
|
+
#
|
|
2711
|
+
#
|
|
2712
|
+
#
|
|
2713
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies
|
|
2123
2714
|
#
|
|
2124
2715
|
# @option params [required, String] :directory_arn
|
|
2125
|
-
# ARN associated with the Directory.
|
|
2716
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory.
|
|
2717
|
+
# For more information, see arns.
|
|
2126
2718
|
#
|
|
2127
2719
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
2128
2720
|
# Reference that identifies the object whose policies will be looked up.
|
|
@@ -2131,8 +2723,8 @@ module Aws::CloudDirectory
|
|
|
2131
2723
|
# The token to request the next page of results.
|
|
2132
2724
|
#
|
|
2133
2725
|
# @option params [Integer] :max_results
|
|
2134
|
-
#
|
|
2135
|
-
# approximate number.
|
|
2726
|
+
# The maximum number of items to be retrieved in a single call. This is
|
|
2727
|
+
# an approximate number.
|
|
2136
2728
|
#
|
|
2137
2729
|
# @return [Types::LookupPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2138
2730
|
#
|
|
@@ -2170,19 +2762,19 @@ module Aws::CloudDirectory
|
|
|
2170
2762
|
end
|
|
2171
2763
|
|
|
2172
2764
|
# Publishes a development schema with a version. If description and
|
|
2173
|
-
# attributes are specified, PublishSchema overrides the development
|
|
2765
|
+
# attributes are specified, `PublishSchema` overrides the development
|
|
2174
2766
|
# schema description and attributes. If not, the development schema
|
|
2175
2767
|
# description and attributes are used.
|
|
2176
2768
|
#
|
|
2177
2769
|
# @option params [required, String] :development_schema_arn
|
|
2178
|
-
# ARN associated with the development
|
|
2179
|
-
# arns.
|
|
2770
|
+
# The Amazon Resource Name (ARN) that is associated with the development
|
|
2771
|
+
# schema. For more information, see arns.
|
|
2180
2772
|
#
|
|
2181
2773
|
# @option params [required, String] :version
|
|
2182
|
-
#
|
|
2774
|
+
# The version under which the schema will be published.
|
|
2183
2775
|
#
|
|
2184
2776
|
# @option params [String] :name
|
|
2185
|
-
#
|
|
2777
|
+
# The new name under which the schema will be published. If this is not
|
|
2186
2778
|
# provided, the development schema is considered.
|
|
2187
2779
|
#
|
|
2188
2780
|
# @return [Types::PublishSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -2282,13 +2874,14 @@ module Aws::CloudDirectory
|
|
|
2282
2874
|
req.send_request(options)
|
|
2283
2875
|
end
|
|
2284
2876
|
|
|
2285
|
-
# API for adding tags to a resource.
|
|
2877
|
+
# An API operation for adding tags to a resource.
|
|
2286
2878
|
#
|
|
2287
2879
|
# @option params [required, String] :resource_arn
|
|
2288
|
-
# ARN of the resource. Tagging is only
|
|
2880
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
|
2881
|
+
# supported for directories.
|
|
2289
2882
|
#
|
|
2290
2883
|
# @option params [required, Array<Types::Tag>] :tags
|
|
2291
|
-
#
|
|
2884
|
+
# A list of tag key-value pairs.
|
|
2292
2885
|
#
|
|
2293
2886
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2294
2887
|
#
|
|
@@ -2313,13 +2906,14 @@ module Aws::CloudDirectory
|
|
|
2313
2906
|
req.send_request(options)
|
|
2314
2907
|
end
|
|
2315
2908
|
|
|
2316
|
-
# API for removing tags from a resource.
|
|
2909
|
+
# An API operation for removing tags from a resource.
|
|
2317
2910
|
#
|
|
2318
2911
|
# @option params [required, String] :resource_arn
|
|
2319
|
-
# ARN of the resource. Tagging is only
|
|
2912
|
+
# The Amazon Resource Name (ARN) of the resource. Tagging is only
|
|
2913
|
+
# supported for directories.
|
|
2320
2914
|
#
|
|
2321
2915
|
# @option params [required, Array<String>] :tag_keys
|
|
2322
|
-
# Keys of the tag that
|
|
2916
|
+
# Keys of the tag that need to be removed from the resource.
|
|
2323
2917
|
#
|
|
2324
2918
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2325
2919
|
#
|
|
@@ -2348,17 +2942,19 @@ module Aws::CloudDirectory
|
|
|
2348
2942
|
# 3. Deletes existing `Attributes`, `Rules`, or `ObjectTypes`.
|
|
2349
2943
|
#
|
|
2350
2944
|
# @option params [required, String] :schema_arn
|
|
2351
|
-
# ARN associated with the Facet. For
|
|
2945
|
+
# The Amazon Resource Name (ARN) that is associated with the Facet. For
|
|
2946
|
+
# more information, see arns.
|
|
2352
2947
|
#
|
|
2353
2948
|
# @option params [required, String] :name
|
|
2949
|
+
# The name of the facet.
|
|
2354
2950
|
#
|
|
2355
2951
|
# @option params [Array<Types::FacetAttributeUpdate>] :attribute_updates
|
|
2356
2952
|
# List of attributes that need to be updated in a given schema Facet.
|
|
2357
|
-
# Each attribute is followed by AttributeAction
|
|
2953
|
+
# Each attribute is followed by `AttributeAction`, which specifies the
|
|
2358
2954
|
# type of update operation to perform.
|
|
2359
2955
|
#
|
|
2360
2956
|
# @option params [String] :object_type
|
|
2361
|
-
#
|
|
2957
|
+
# The object type that is associated with the facet. See
|
|
2362
2958
|
# CreateFacetRequest$ObjectType for more details.
|
|
2363
2959
|
#
|
|
2364
2960
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
@@ -2415,14 +3011,14 @@ module Aws::CloudDirectory
|
|
|
2415
3011
|
# Updates a given object's attributes.
|
|
2416
3012
|
#
|
|
2417
3013
|
# @option params [required, String] :directory_arn
|
|
2418
|
-
#
|
|
2419
|
-
# information, see arns.
|
|
3014
|
+
# The Amazon Resource Name (ARN) that is associated with the Directory
|
|
3015
|
+
# where the object resides. For more information, see arns.
|
|
2420
3016
|
#
|
|
2421
3017
|
# @option params [required, Types::ObjectReference] :object_reference
|
|
2422
|
-
#
|
|
3018
|
+
# The reference that identifies the object.
|
|
2423
3019
|
#
|
|
2424
3020
|
# @option params [required, Array<Types::ObjectAttributeUpdate>] :attribute_updates
|
|
2425
|
-
#
|
|
3021
|
+
# The attributes update structure.
|
|
2426
3022
|
#
|
|
2427
3023
|
# @return [Types::UpdateObjectAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2428
3024
|
#
|
|
@@ -2473,10 +3069,11 @@ module Aws::CloudDirectory
|
|
|
2473
3069
|
# can be updated.
|
|
2474
3070
|
#
|
|
2475
3071
|
# @option params [required, String] :schema_arn
|
|
2476
|
-
# ARN of the development schema. For more
|
|
3072
|
+
# The Amazon Resource Name (ARN) of the development schema. For more
|
|
3073
|
+
# information, see arns.
|
|
2477
3074
|
#
|
|
2478
3075
|
# @option params [required, String] :name
|
|
2479
|
-
#
|
|
3076
|
+
# The name of the schema.
|
|
2480
3077
|
#
|
|
2481
3078
|
# @return [Types::UpdateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2482
3079
|
#
|
|
@@ -2502,6 +3099,82 @@ module Aws::CloudDirectory
|
|
|
2502
3099
|
req.send_request(options)
|
|
2503
3100
|
end
|
|
2504
3101
|
|
|
3102
|
+
# Updates a TypedLinkFacet. For more information, see [Typed link][1].
|
|
3103
|
+
#
|
|
3104
|
+
#
|
|
3105
|
+
#
|
|
3106
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
3107
|
+
#
|
|
3108
|
+
# @option params [required, String] :schema_arn
|
|
3109
|
+
# The Amazon Resource Name (ARN) that is associated with the schema. For
|
|
3110
|
+
# more information, see arns.
|
|
3111
|
+
#
|
|
3112
|
+
# @option params [required, String] :name
|
|
3113
|
+
# The unique name of the typed link facet.
|
|
3114
|
+
#
|
|
3115
|
+
# @option params [required, Array<Types::TypedLinkFacetAttributeUpdate>] :attribute_updates
|
|
3116
|
+
# Attributes update structure.
|
|
3117
|
+
#
|
|
3118
|
+
# @option params [required, Array<String>] :identity_attribute_order
|
|
3119
|
+
# The order of identity attributes for the facet, from most significant
|
|
3120
|
+
# to least significant. The ability to filter typed links considers the
|
|
3121
|
+
# order that the attributes are defined on the typed link facet. When
|
|
3122
|
+
# providing ranges to a typed link selection, any inexact ranges must be
|
|
3123
|
+
# specified at the end. Any attributes that do not have a range
|
|
3124
|
+
# specified are presumed to match the entire range. Filters are
|
|
3125
|
+
# interpreted in the order of the attributes on the typed link facet,
|
|
3126
|
+
# not the order in which they are supplied to any API calls. For more
|
|
3127
|
+
# information about identity attributes, see [Typed link][1].
|
|
3128
|
+
#
|
|
3129
|
+
#
|
|
3130
|
+
#
|
|
3131
|
+
# [1]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink
|
|
3132
|
+
#
|
|
3133
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3134
|
+
#
|
|
3135
|
+
# @example Request syntax with placeholder values
|
|
3136
|
+
#
|
|
3137
|
+
# resp = client.update_typed_link_facet({
|
|
3138
|
+
# schema_arn: "Arn", # required
|
|
3139
|
+
# name: "TypedLinkName", # required
|
|
3140
|
+
# attribute_updates: [ # required
|
|
3141
|
+
# {
|
|
3142
|
+
# attribute: { # required
|
|
3143
|
+
# name: "AttributeName", # required
|
|
3144
|
+
# type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
|
|
3145
|
+
# default_value: {
|
|
3146
|
+
# string_value: "StringAttributeValue",
|
|
3147
|
+
# binary_value: "data",
|
|
3148
|
+
# boolean_value: false,
|
|
3149
|
+
# number_value: "NumberAttributeValue",
|
|
3150
|
+
# datetime_value: Time.now,
|
|
3151
|
+
# },
|
|
3152
|
+
# is_immutable: false,
|
|
3153
|
+
# rules: {
|
|
3154
|
+
# "RuleKey" => {
|
|
3155
|
+
# type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
|
|
3156
|
+
# parameters: {
|
|
3157
|
+
# "RuleParameterKey" => "RuleParameterValue",
|
|
3158
|
+
# },
|
|
3159
|
+
# },
|
|
3160
|
+
# },
|
|
3161
|
+
# required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
|
|
3162
|
+
# },
|
|
3163
|
+
# action: "CREATE_OR_UPDATE", # required, accepts CREATE_OR_UPDATE, DELETE
|
|
3164
|
+
# },
|
|
3165
|
+
# ],
|
|
3166
|
+
# identity_attribute_order: ["AttributeName"], # required
|
|
3167
|
+
# })
|
|
3168
|
+
#
|
|
3169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateTypedLinkFacet AWS API Documentation
|
|
3170
|
+
#
|
|
3171
|
+
# @overload update_typed_link_facet(params = {})
|
|
3172
|
+
# @param [Hash] params ({})
|
|
3173
|
+
def update_typed_link_facet(params = {}, options = {})
|
|
3174
|
+
req = build_request(:update_typed_link_facet, params)
|
|
3175
|
+
req.send_request(options)
|
|
3176
|
+
end
|
|
3177
|
+
|
|
2505
3178
|
# @!endgroup
|
|
2506
3179
|
|
|
2507
3180
|
# @param params ({})
|
|
@@ -2515,7 +3188,7 @@ module Aws::CloudDirectory
|
|
|
2515
3188
|
params: params,
|
|
2516
3189
|
config: config)
|
|
2517
3190
|
context[:gem_name] = 'aws-sdk-clouddirectory'
|
|
2518
|
-
context[:gem_version] = '1.0.0.
|
|
3191
|
+
context[:gem_version] = '1.0.0.rc6'
|
|
2519
3192
|
Seahorse::Client::Request.new(handlers, context)
|
|
2520
3193
|
end
|
|
2521
3194
|
|