@aws-sdk/client-clouddirectory 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +559 -0
- package/package.json +5 -5
|
@@ -19,15 +19,18 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
*/
|
|
20
20
|
export interface AttributeKey {
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>The Amazon Resource Name (ARN) of the schema that contains the facet and
|
|
23
24
|
* attribute.</p>
|
|
24
25
|
*/
|
|
25
26
|
SchemaArn: string | undefined;
|
|
26
27
|
/**
|
|
28
|
+
* @public
|
|
27
29
|
* <p>The name of the facet that the attribute exists within.</p>
|
|
28
30
|
*/
|
|
29
31
|
FacetName: string | undefined;
|
|
30
32
|
/**
|
|
33
|
+
* @public
|
|
31
34
|
* <p>The name of the attribute.</p>
|
|
32
35
|
*/
|
|
33
36
|
Name: string | undefined;
|
|
@@ -44,6 +47,7 @@ export type TypedAttributeValue = TypedAttributeValue.BinaryValueMember | TypedA
|
|
|
44
47
|
*/
|
|
45
48
|
export declare namespace TypedAttributeValue {
|
|
46
49
|
/**
|
|
50
|
+
* @public
|
|
47
51
|
* <p>A string data value.</p>
|
|
48
52
|
*/
|
|
49
53
|
interface StringValueMember {
|
|
@@ -55,6 +59,7 @@ export declare namespace TypedAttributeValue {
|
|
|
55
59
|
$unknown?: never;
|
|
56
60
|
}
|
|
57
61
|
/**
|
|
62
|
+
* @public
|
|
58
63
|
* <p>A binary data value.</p>
|
|
59
64
|
*/
|
|
60
65
|
interface BinaryValueMember {
|
|
@@ -66,6 +71,7 @@ export declare namespace TypedAttributeValue {
|
|
|
66
71
|
$unknown?: never;
|
|
67
72
|
}
|
|
68
73
|
/**
|
|
74
|
+
* @public
|
|
69
75
|
* <p>A Boolean data value.</p>
|
|
70
76
|
*/
|
|
71
77
|
interface BooleanValueMember {
|
|
@@ -77,6 +83,7 @@ export declare namespace TypedAttributeValue {
|
|
|
77
83
|
$unknown?: never;
|
|
78
84
|
}
|
|
79
85
|
/**
|
|
86
|
+
* @public
|
|
80
87
|
* <p>A number data value.</p>
|
|
81
88
|
*/
|
|
82
89
|
interface NumberValueMember {
|
|
@@ -88,6 +95,7 @@ export declare namespace TypedAttributeValue {
|
|
|
88
95
|
$unknown?: never;
|
|
89
96
|
}
|
|
90
97
|
/**
|
|
98
|
+
* @public
|
|
91
99
|
* <p>A date and time value.</p>
|
|
92
100
|
*/
|
|
93
101
|
interface DatetimeValueMember {
|
|
@@ -98,6 +106,9 @@ export declare namespace TypedAttributeValue {
|
|
|
98
106
|
DatetimeValue: Date;
|
|
99
107
|
$unknown?: never;
|
|
100
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
101
112
|
interface $UnknownMember {
|
|
102
113
|
StringValue?: never;
|
|
103
114
|
BinaryValue?: never;
|
|
@@ -122,10 +133,12 @@ export declare namespace TypedAttributeValue {
|
|
|
122
133
|
*/
|
|
123
134
|
export interface AttributeKeyAndValue {
|
|
124
135
|
/**
|
|
136
|
+
* @public
|
|
125
137
|
* <p>The key of the attribute.</p>
|
|
126
138
|
*/
|
|
127
139
|
Key: AttributeKey | undefined;
|
|
128
140
|
/**
|
|
141
|
+
* @public
|
|
129
142
|
* <p>The value of the attribute.</p>
|
|
130
143
|
*/
|
|
131
144
|
Value: TypedAttributeValue | undefined;
|
|
@@ -136,6 +149,7 @@ export interface AttributeKeyAndValue {
|
|
|
136
149
|
*/
|
|
137
150
|
export interface ObjectReference {
|
|
138
151
|
/**
|
|
152
|
+
* @public
|
|
139
153
|
* <p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html">Access Objects</a>. You can identify an object in one of the following ways:</p>
|
|
140
154
|
* <ul>
|
|
141
155
|
* <li>
|
|
@@ -160,11 +174,13 @@ export interface ObjectReference {
|
|
|
160
174
|
*/
|
|
161
175
|
export interface SchemaFacet {
|
|
162
176
|
/**
|
|
177
|
+
* @public
|
|
163
178
|
* <p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html">In-Place Schema Upgrade</a> for a description of when to provide minor versions.
|
|
164
179
|
* If this value is set, FacetName must also be set.</p>
|
|
165
180
|
*/
|
|
166
181
|
SchemaArn?: string;
|
|
167
182
|
/**
|
|
183
|
+
* @public
|
|
168
184
|
* <p>The name of the facet. If this value is set, SchemaArn must also be set.</p>
|
|
169
185
|
*/
|
|
170
186
|
FacetName?: string;
|
|
@@ -174,19 +190,23 @@ export interface SchemaFacet {
|
|
|
174
190
|
*/
|
|
175
191
|
export interface AddFacetToObjectRequest {
|
|
176
192
|
/**
|
|
193
|
+
* @public
|
|
177
194
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
178
195
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
179
196
|
*/
|
|
180
197
|
DirectoryArn: string | undefined;
|
|
181
198
|
/**
|
|
199
|
+
* @public
|
|
182
200
|
* <p>Identifiers for the facet that you are adding to the object. See <a>SchemaFacet</a> for details.</p>
|
|
183
201
|
*/
|
|
184
202
|
SchemaFacet: SchemaFacet | undefined;
|
|
185
203
|
/**
|
|
204
|
+
* @public
|
|
186
205
|
* <p>Attributes on the facet that you are adding to the object.</p>
|
|
187
206
|
*/
|
|
188
207
|
ObjectAttributeList?: AttributeKeyAndValue[];
|
|
189
208
|
/**
|
|
209
|
+
* @public
|
|
190
210
|
* <p>A reference to the object you are adding the specified facet to.</p>
|
|
191
211
|
*/
|
|
192
212
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -307,11 +327,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
307
327
|
*/
|
|
308
328
|
export interface ApplySchemaRequest {
|
|
309
329
|
/**
|
|
330
|
+
* @public
|
|
310
331
|
* <p>Published schema Amazon Resource Name (ARN) that needs to be copied. For more
|
|
311
332
|
* information, see <a>arns</a>.</p>
|
|
312
333
|
*/
|
|
313
334
|
PublishedSchemaArn: string | undefined;
|
|
314
335
|
/**
|
|
336
|
+
* @public
|
|
315
337
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
316
338
|
* into which the schema is copied. For more information, see <a>arns</a>.</p>
|
|
317
339
|
*/
|
|
@@ -322,11 +344,13 @@ export interface ApplySchemaRequest {
|
|
|
322
344
|
*/
|
|
323
345
|
export interface ApplySchemaResponse {
|
|
324
346
|
/**
|
|
347
|
+
* @public
|
|
325
348
|
* <p>The applied schema ARN that is associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on
|
|
326
349
|
* this directory. For more information, see <a>arns</a>.</p>
|
|
327
350
|
*/
|
|
328
351
|
AppliedSchemaArn?: string;
|
|
329
352
|
/**
|
|
353
|
+
* @public
|
|
330
354
|
* <p>The ARN that is associated with the <a>Directory</a>. For more information,
|
|
331
355
|
* see <a>arns</a>.</p>
|
|
332
356
|
*/
|
|
@@ -365,19 +389,23 @@ export declare class SchemaAlreadyExistsException extends __BaseException {
|
|
|
365
389
|
*/
|
|
366
390
|
export interface AttachObjectRequest {
|
|
367
391
|
/**
|
|
392
|
+
* @public
|
|
368
393
|
* <p>Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
369
394
|
* where both objects reside. For more information, see <a>arns</a>.</p>
|
|
370
395
|
*/
|
|
371
396
|
DirectoryArn: string | undefined;
|
|
372
397
|
/**
|
|
398
|
+
* @public
|
|
373
399
|
* <p>The parent object reference.</p>
|
|
374
400
|
*/
|
|
375
401
|
ParentReference: ObjectReference | undefined;
|
|
376
402
|
/**
|
|
403
|
+
* @public
|
|
377
404
|
* <p>The child object reference to be attached to the object.</p>
|
|
378
405
|
*/
|
|
379
406
|
ChildReference: ObjectReference | undefined;
|
|
380
407
|
/**
|
|
408
|
+
* @public
|
|
381
409
|
* <p>The link name with which the child object is attached to the parent.</p>
|
|
382
410
|
*/
|
|
383
411
|
LinkName: string | undefined;
|
|
@@ -387,6 +415,7 @@ export interface AttachObjectRequest {
|
|
|
387
415
|
*/
|
|
388
416
|
export interface AttachObjectResponse {
|
|
389
417
|
/**
|
|
418
|
+
* @public
|
|
390
419
|
* <p>The attached <code>ObjectIdentifier</code>, which is the child
|
|
391
420
|
* <code>ObjectIdentifier</code>.</p>
|
|
392
421
|
*/
|
|
@@ -411,15 +440,18 @@ export declare class LinkNameAlreadyInUseException extends __BaseException {
|
|
|
411
440
|
*/
|
|
412
441
|
export interface AttachPolicyRequest {
|
|
413
442
|
/**
|
|
443
|
+
* @public
|
|
414
444
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
415
445
|
* where both objects reside. For more information, see <a>arns</a>.</p>
|
|
416
446
|
*/
|
|
417
447
|
DirectoryArn: string | undefined;
|
|
418
448
|
/**
|
|
449
|
+
* @public
|
|
419
450
|
* <p>The reference that is associated with the policy object.</p>
|
|
420
451
|
*/
|
|
421
452
|
PolicyReference: ObjectReference | undefined;
|
|
422
453
|
/**
|
|
454
|
+
* @public
|
|
423
455
|
* <p>The reference that identifies the object to which the policy will be
|
|
424
456
|
* attached.</p>
|
|
425
457
|
*/
|
|
@@ -448,15 +480,18 @@ export declare class NotPolicyException extends __BaseException {
|
|
|
448
480
|
*/
|
|
449
481
|
export interface AttachToIndexRequest {
|
|
450
482
|
/**
|
|
483
|
+
* @public
|
|
451
484
|
* <p>The Amazon Resource Name (ARN) of the directory where the object and index
|
|
452
485
|
* exist.</p>
|
|
453
486
|
*/
|
|
454
487
|
DirectoryArn: string | undefined;
|
|
455
488
|
/**
|
|
489
|
+
* @public
|
|
456
490
|
* <p>A reference to the index that you are attaching the object to.</p>
|
|
457
491
|
*/
|
|
458
492
|
IndexReference: ObjectReference | undefined;
|
|
459
493
|
/**
|
|
494
|
+
* @public
|
|
460
495
|
* <p>A reference to the object that you are attaching to the index.</p>
|
|
461
496
|
*/
|
|
462
497
|
TargetReference: ObjectReference | undefined;
|
|
@@ -466,6 +501,7 @@ export interface AttachToIndexRequest {
|
|
|
466
501
|
*/
|
|
467
502
|
export interface AttachToIndexResponse {
|
|
468
503
|
/**
|
|
504
|
+
* @public
|
|
469
505
|
* <p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>
|
|
470
506
|
*/
|
|
471
507
|
AttachedObjectIdentifier?: string;
|
|
@@ -502,10 +538,12 @@ export declare class NotIndexException extends __BaseException {
|
|
|
502
538
|
*/
|
|
503
539
|
export interface AttributeNameAndValue {
|
|
504
540
|
/**
|
|
541
|
+
* @public
|
|
505
542
|
* <p>The attribute name of the typed link.</p>
|
|
506
543
|
*/
|
|
507
544
|
AttributeName: string | undefined;
|
|
508
545
|
/**
|
|
546
|
+
* @public
|
|
509
547
|
* <p>The value for the typed link.</p>
|
|
510
548
|
*/
|
|
511
549
|
Value: TypedAttributeValue | undefined;
|
|
@@ -517,11 +555,13 @@ export interface AttributeNameAndValue {
|
|
|
517
555
|
*/
|
|
518
556
|
export interface TypedLinkSchemaAndFacetName {
|
|
519
557
|
/**
|
|
558
|
+
* @public
|
|
520
559
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
521
560
|
* information, see <a>arns</a>.</p>
|
|
522
561
|
*/
|
|
523
562
|
SchemaArn: string | undefined;
|
|
524
563
|
/**
|
|
564
|
+
* @public
|
|
525
565
|
* <p>The unique name of the typed link facet.</p>
|
|
526
566
|
*/
|
|
527
567
|
TypedLinkName: string | undefined;
|
|
@@ -531,23 +571,28 @@ export interface TypedLinkSchemaAndFacetName {
|
|
|
531
571
|
*/
|
|
532
572
|
export interface AttachTypedLinkRequest {
|
|
533
573
|
/**
|
|
574
|
+
* @public
|
|
534
575
|
* <p>The Amazon Resource Name (ARN) of the directory where you want to attach the typed
|
|
535
576
|
* link.</p>
|
|
536
577
|
*/
|
|
537
578
|
DirectoryArn: string | undefined;
|
|
538
579
|
/**
|
|
580
|
+
* @public
|
|
539
581
|
* <p>Identifies the source object that the typed link will attach to.</p>
|
|
540
582
|
*/
|
|
541
583
|
SourceObjectReference: ObjectReference | undefined;
|
|
542
584
|
/**
|
|
585
|
+
* @public
|
|
543
586
|
* <p>Identifies the target object that the typed link will attach to.</p>
|
|
544
587
|
*/
|
|
545
588
|
TargetObjectReference: ObjectReference | undefined;
|
|
546
589
|
/**
|
|
590
|
+
* @public
|
|
547
591
|
* <p>Identifies the typed link facet that is associated with the typed link.</p>
|
|
548
592
|
*/
|
|
549
593
|
TypedLinkFacet: TypedLinkSchemaAndFacetName | undefined;
|
|
550
594
|
/**
|
|
595
|
+
* @public
|
|
551
596
|
* <p>A set of attributes that are associated with the typed link.</p>
|
|
552
597
|
*/
|
|
553
598
|
Attributes: AttributeNameAndValue[] | undefined;
|
|
@@ -562,18 +607,22 @@ export interface AttachTypedLinkRequest {
|
|
|
562
607
|
*/
|
|
563
608
|
export interface TypedLinkSpecifier {
|
|
564
609
|
/**
|
|
610
|
+
* @public
|
|
565
611
|
* <p>Identifies the typed link facet that is associated with the typed link.</p>
|
|
566
612
|
*/
|
|
567
613
|
TypedLinkFacet: TypedLinkSchemaAndFacetName | undefined;
|
|
568
614
|
/**
|
|
615
|
+
* @public
|
|
569
616
|
* <p>Identifies the source object that the typed link will attach to.</p>
|
|
570
617
|
*/
|
|
571
618
|
SourceObjectReference: ObjectReference | undefined;
|
|
572
619
|
/**
|
|
620
|
+
* @public
|
|
573
621
|
* <p>Identifies the target object that the typed link will attach to.</p>
|
|
574
622
|
*/
|
|
575
623
|
TargetObjectReference: ObjectReference | undefined;
|
|
576
624
|
/**
|
|
625
|
+
* @public
|
|
577
626
|
* <p>Identifies the attribute value to update.</p>
|
|
578
627
|
*/
|
|
579
628
|
IdentityAttributeValues: AttributeNameAndValue[] | undefined;
|
|
@@ -583,6 +632,7 @@ export interface TypedLinkSpecifier {
|
|
|
583
632
|
*/
|
|
584
633
|
export interface AttachTypedLinkResponse {
|
|
585
634
|
/**
|
|
635
|
+
* @public
|
|
586
636
|
* <p>Returns a typed link specifier as output.</p>
|
|
587
637
|
*/
|
|
588
638
|
TypedLinkSpecifier?: TypedLinkSpecifier;
|
|
@@ -605,10 +655,12 @@ export type ConsistencyLevel = (typeof ConsistencyLevel)[keyof typeof Consistenc
|
|
|
605
655
|
*/
|
|
606
656
|
export interface BatchGetLinkAttributes {
|
|
607
657
|
/**
|
|
658
|
+
* @public
|
|
608
659
|
* <p>Allows a typed link specifier to be accepted as input.</p>
|
|
609
660
|
*/
|
|
610
661
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
611
662
|
/**
|
|
663
|
+
* @public
|
|
612
664
|
* <p>A list of attribute names whose values will be retrieved.</p>
|
|
613
665
|
*/
|
|
614
666
|
AttributeNames: string[] | undefined;
|
|
@@ -619,14 +671,17 @@ export interface BatchGetLinkAttributes {
|
|
|
619
671
|
*/
|
|
620
672
|
export interface BatchGetObjectAttributes {
|
|
621
673
|
/**
|
|
674
|
+
* @public
|
|
622
675
|
* <p>Reference that identifies the object whose attributes will be retrieved.</p>
|
|
623
676
|
*/
|
|
624
677
|
ObjectReference: ObjectReference | undefined;
|
|
625
678
|
/**
|
|
679
|
+
* @public
|
|
626
680
|
* <p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>
|
|
627
681
|
*/
|
|
628
682
|
SchemaFacet: SchemaFacet | undefined;
|
|
629
683
|
/**
|
|
684
|
+
* @public
|
|
630
685
|
* <p>List of attribute names whose values will be retrieved.</p>
|
|
631
686
|
*/
|
|
632
687
|
AttributeNames: string[] | undefined;
|
|
@@ -637,6 +692,7 @@ export interface BatchGetObjectAttributes {
|
|
|
637
692
|
*/
|
|
638
693
|
export interface BatchGetObjectInformation {
|
|
639
694
|
/**
|
|
695
|
+
* @public
|
|
640
696
|
* <p>A reference to the object.</p>
|
|
641
697
|
*/
|
|
642
698
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -647,14 +703,17 @@ export interface BatchGetObjectInformation {
|
|
|
647
703
|
*/
|
|
648
704
|
export interface BatchListAttachedIndices {
|
|
649
705
|
/**
|
|
706
|
+
* @public
|
|
650
707
|
* <p>A reference to the object that has indices attached.</p>
|
|
651
708
|
*/
|
|
652
709
|
TargetReference: ObjectReference | undefined;
|
|
653
710
|
/**
|
|
711
|
+
* @public
|
|
654
712
|
* <p>The pagination token.</p>
|
|
655
713
|
*/
|
|
656
714
|
NextToken?: string;
|
|
657
715
|
/**
|
|
716
|
+
* @public
|
|
658
717
|
* <p>The maximum number of results to retrieve.</p>
|
|
659
718
|
*/
|
|
660
719
|
MaxResults?: number;
|
|
@@ -680,18 +739,22 @@ export type RangeMode = (typeof RangeMode)[keyof typeof RangeMode];
|
|
|
680
739
|
*/
|
|
681
740
|
export interface TypedAttributeValueRange {
|
|
682
741
|
/**
|
|
742
|
+
* @public
|
|
683
743
|
* <p>The inclusive or exclusive range start.</p>
|
|
684
744
|
*/
|
|
685
745
|
StartMode: RangeMode | string | undefined;
|
|
686
746
|
/**
|
|
747
|
+
* @public
|
|
687
748
|
* <p>The value to start the range at.</p>
|
|
688
749
|
*/
|
|
689
750
|
StartValue?: TypedAttributeValue;
|
|
690
751
|
/**
|
|
752
|
+
* @public
|
|
691
753
|
* <p>The inclusive or exclusive range end.</p>
|
|
692
754
|
*/
|
|
693
755
|
EndMode: RangeMode | string | undefined;
|
|
694
756
|
/**
|
|
757
|
+
* @public
|
|
695
758
|
* <p>The attribute value to terminate the range at.</p>
|
|
696
759
|
*/
|
|
697
760
|
EndValue?: TypedAttributeValue;
|
|
@@ -702,10 +765,12 @@ export interface TypedAttributeValueRange {
|
|
|
702
765
|
*/
|
|
703
766
|
export interface TypedLinkAttributeRange {
|
|
704
767
|
/**
|
|
768
|
+
* @public
|
|
705
769
|
* <p>The unique name of the typed link attribute.</p>
|
|
706
770
|
*/
|
|
707
771
|
AttributeName?: string;
|
|
708
772
|
/**
|
|
773
|
+
* @public
|
|
709
774
|
* <p>The range of attribute values that are being selected.</p>
|
|
710
775
|
*/
|
|
711
776
|
Range: TypedAttributeValueRange | undefined;
|
|
@@ -716,25 +781,30 @@ export interface TypedLinkAttributeRange {
|
|
|
716
781
|
*/
|
|
717
782
|
export interface BatchListIncomingTypedLinks {
|
|
718
783
|
/**
|
|
784
|
+
* @public
|
|
719
785
|
* <p>The reference that identifies the object whose attributes will be listed.</p>
|
|
720
786
|
*/
|
|
721
787
|
ObjectReference: ObjectReference | undefined;
|
|
722
788
|
/**
|
|
789
|
+
* @public
|
|
723
790
|
* <p>Provides range filters for multiple attributes. When providing ranges to typed link
|
|
724
791
|
* selection, any inexact ranges must be specified at the end. Any attributes that do not have a
|
|
725
792
|
* range specified are presumed to match the entire range.</p>
|
|
726
793
|
*/
|
|
727
794
|
FilterAttributeRanges?: TypedLinkAttributeRange[];
|
|
728
795
|
/**
|
|
796
|
+
* @public
|
|
729
797
|
* <p>Filters are interpreted in the order of the attributes on the typed link facet, not the
|
|
730
798
|
* order in which they are supplied to any API calls.</p>
|
|
731
799
|
*/
|
|
732
800
|
FilterTypedLink?: TypedLinkSchemaAndFacetName;
|
|
733
801
|
/**
|
|
802
|
+
* @public
|
|
734
803
|
* <p>The pagination token.</p>
|
|
735
804
|
*/
|
|
736
805
|
NextToken?: string;
|
|
737
806
|
/**
|
|
807
|
+
* @public
|
|
738
808
|
* <p>The maximum number of results to retrieve.</p>
|
|
739
809
|
*/
|
|
740
810
|
MaxResults?: number;
|
|
@@ -745,10 +815,12 @@ export interface BatchListIncomingTypedLinks {
|
|
|
745
815
|
*/
|
|
746
816
|
export interface ObjectAttributeRange {
|
|
747
817
|
/**
|
|
818
|
+
* @public
|
|
748
819
|
* <p>The key of the attribute that the attribute range covers.</p>
|
|
749
820
|
*/
|
|
750
821
|
AttributeKey?: AttributeKey;
|
|
751
822
|
/**
|
|
823
|
+
* @public
|
|
752
824
|
* <p>The range of attribute values being selected.</p>
|
|
753
825
|
*/
|
|
754
826
|
Range?: TypedAttributeValueRange;
|
|
@@ -759,18 +831,22 @@ export interface ObjectAttributeRange {
|
|
|
759
831
|
*/
|
|
760
832
|
export interface BatchListIndex {
|
|
761
833
|
/**
|
|
834
|
+
* @public
|
|
762
835
|
* <p>Specifies the ranges of indexed values that you want to query.</p>
|
|
763
836
|
*/
|
|
764
837
|
RangesOnIndexedValues?: ObjectAttributeRange[];
|
|
765
838
|
/**
|
|
839
|
+
* @public
|
|
766
840
|
* <p>The reference to the index to list.</p>
|
|
767
841
|
*/
|
|
768
842
|
IndexReference: ObjectReference | undefined;
|
|
769
843
|
/**
|
|
844
|
+
* @public
|
|
770
845
|
* <p>The maximum number of results to retrieve.</p>
|
|
771
846
|
*/
|
|
772
847
|
MaxResults?: number;
|
|
773
848
|
/**
|
|
849
|
+
* @public
|
|
774
850
|
* <p>The pagination token.</p>
|
|
775
851
|
*/
|
|
776
852
|
NextToken?: string;
|
|
@@ -781,19 +857,23 @@ export interface BatchListIndex {
|
|
|
781
857
|
*/
|
|
782
858
|
export interface BatchListObjectAttributes {
|
|
783
859
|
/**
|
|
860
|
+
* @public
|
|
784
861
|
* <p>Reference of the object whose attributes need to be listed.</p>
|
|
785
862
|
*/
|
|
786
863
|
ObjectReference: ObjectReference | undefined;
|
|
787
864
|
/**
|
|
865
|
+
* @public
|
|
788
866
|
* <p>The pagination token.</p>
|
|
789
867
|
*/
|
|
790
868
|
NextToken?: string;
|
|
791
869
|
/**
|
|
870
|
+
* @public
|
|
792
871
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
793
872
|
* number.</p>
|
|
794
873
|
*/
|
|
795
874
|
MaxResults?: number;
|
|
796
875
|
/**
|
|
876
|
+
* @public
|
|
797
877
|
* <p>Used to filter the list of object attributes that are associated with a certain
|
|
798
878
|
* facet.</p>
|
|
799
879
|
*/
|
|
@@ -805,14 +885,17 @@ export interface BatchListObjectAttributes {
|
|
|
805
885
|
*/
|
|
806
886
|
export interface BatchListObjectChildren {
|
|
807
887
|
/**
|
|
888
|
+
* @public
|
|
808
889
|
* <p>Reference of the object for which child objects are being listed.</p>
|
|
809
890
|
*/
|
|
810
891
|
ObjectReference: ObjectReference | undefined;
|
|
811
892
|
/**
|
|
893
|
+
* @public
|
|
812
894
|
* <p>The pagination token.</p>
|
|
813
895
|
*/
|
|
814
896
|
NextToken?: string;
|
|
815
897
|
/**
|
|
898
|
+
* @public
|
|
816
899
|
* <p>Maximum number of items to be retrieved in a single call. This is an approximate
|
|
817
900
|
* number.</p>
|
|
818
901
|
*/
|
|
@@ -824,14 +907,17 @@ export interface BatchListObjectChildren {
|
|
|
824
907
|
*/
|
|
825
908
|
export interface BatchListObjectParentPaths {
|
|
826
909
|
/**
|
|
910
|
+
* @public
|
|
827
911
|
* <p>The reference that identifies the object whose attributes will be listed.</p>
|
|
828
912
|
*/
|
|
829
913
|
ObjectReference: ObjectReference | undefined;
|
|
830
914
|
/**
|
|
915
|
+
* @public
|
|
831
916
|
* <p>The pagination token.</p>
|
|
832
917
|
*/
|
|
833
918
|
NextToken?: string;
|
|
834
919
|
/**
|
|
920
|
+
* @public
|
|
835
921
|
* <p>The maximum number of results to retrieve.</p>
|
|
836
922
|
*/
|
|
837
923
|
MaxResults?: number;
|
|
@@ -843,14 +929,17 @@ export interface BatchListObjectParentPaths {
|
|
|
843
929
|
*/
|
|
844
930
|
export interface BatchListObjectParents {
|
|
845
931
|
/**
|
|
932
|
+
* @public
|
|
846
933
|
* <p>The reference that identifies an object.</p>
|
|
847
934
|
*/
|
|
848
935
|
ObjectReference: ObjectReference | undefined;
|
|
849
936
|
/**
|
|
937
|
+
* @public
|
|
850
938
|
* <p>The pagination token.</p>
|
|
851
939
|
*/
|
|
852
940
|
NextToken?: string;
|
|
853
941
|
/**
|
|
942
|
+
* @public
|
|
854
943
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
855
944
|
* number.</p>
|
|
856
945
|
*/
|
|
@@ -862,14 +951,17 @@ export interface BatchListObjectParents {
|
|
|
862
951
|
*/
|
|
863
952
|
export interface BatchListObjectPolicies {
|
|
864
953
|
/**
|
|
954
|
+
* @public
|
|
865
955
|
* <p>The reference that identifies the object whose attributes will be listed.</p>
|
|
866
956
|
*/
|
|
867
957
|
ObjectReference: ObjectReference | undefined;
|
|
868
958
|
/**
|
|
959
|
+
* @public
|
|
869
960
|
* <p>The pagination token.</p>
|
|
870
961
|
*/
|
|
871
962
|
NextToken?: string;
|
|
872
963
|
/**
|
|
964
|
+
* @public
|
|
873
965
|
* <p>The maximum number of results to retrieve.</p>
|
|
874
966
|
*/
|
|
875
967
|
MaxResults?: number;
|
|
@@ -880,25 +972,30 @@ export interface BatchListObjectPolicies {
|
|
|
880
972
|
*/
|
|
881
973
|
export interface BatchListOutgoingTypedLinks {
|
|
882
974
|
/**
|
|
975
|
+
* @public
|
|
883
976
|
* <p>The reference that identifies the object whose attributes will be listed.</p>
|
|
884
977
|
*/
|
|
885
978
|
ObjectReference: ObjectReference | undefined;
|
|
886
979
|
/**
|
|
980
|
+
* @public
|
|
887
981
|
* <p>Provides range filters for multiple attributes. When providing ranges to typed link
|
|
888
982
|
* selection, any inexact ranges must be specified at the end. Any attributes that do not have a
|
|
889
983
|
* range specified are presumed to match the entire range.</p>
|
|
890
984
|
*/
|
|
891
985
|
FilterAttributeRanges?: TypedLinkAttributeRange[];
|
|
892
986
|
/**
|
|
987
|
+
* @public
|
|
893
988
|
* <p>Filters are interpreted in the order of the attributes defined on the typed link facet,
|
|
894
989
|
* not the order they are supplied to any API calls.</p>
|
|
895
990
|
*/
|
|
896
991
|
FilterTypedLink?: TypedLinkSchemaAndFacetName;
|
|
897
992
|
/**
|
|
993
|
+
* @public
|
|
898
994
|
* <p>The pagination token.</p>
|
|
899
995
|
*/
|
|
900
996
|
NextToken?: string;
|
|
901
997
|
/**
|
|
998
|
+
* @public
|
|
902
999
|
* <p>The maximum number of results to retrieve.</p>
|
|
903
1000
|
*/
|
|
904
1001
|
MaxResults?: number;
|
|
@@ -909,14 +1006,17 @@ export interface BatchListOutgoingTypedLinks {
|
|
|
909
1006
|
*/
|
|
910
1007
|
export interface BatchListPolicyAttachments {
|
|
911
1008
|
/**
|
|
1009
|
+
* @public
|
|
912
1010
|
* <p>The reference that identifies the policy object.</p>
|
|
913
1011
|
*/
|
|
914
1012
|
PolicyReference: ObjectReference | undefined;
|
|
915
1013
|
/**
|
|
1014
|
+
* @public
|
|
916
1015
|
* <p>The pagination token.</p>
|
|
917
1016
|
*/
|
|
918
1017
|
NextToken?: string;
|
|
919
1018
|
/**
|
|
1019
|
+
* @public
|
|
920
1020
|
* <p>The maximum number of results to retrieve.</p>
|
|
921
1021
|
*/
|
|
922
1022
|
MaxResults?: number;
|
|
@@ -927,14 +1027,17 @@ export interface BatchListPolicyAttachments {
|
|
|
927
1027
|
*/
|
|
928
1028
|
export interface BatchLookupPolicy {
|
|
929
1029
|
/**
|
|
1030
|
+
* @public
|
|
930
1031
|
* <p>Reference that identifies the object whose policies will be looked up.</p>
|
|
931
1032
|
*/
|
|
932
1033
|
ObjectReference: ObjectReference | undefined;
|
|
933
1034
|
/**
|
|
1035
|
+
* @public
|
|
934
1036
|
* <p>The pagination token.</p>
|
|
935
1037
|
*/
|
|
936
1038
|
NextToken?: string;
|
|
937
1039
|
/**
|
|
1040
|
+
* @public
|
|
938
1041
|
* <p>The maximum number of results to retrieve.</p>
|
|
939
1042
|
*/
|
|
940
1043
|
MaxResults?: number;
|
|
@@ -945,45 +1048,55 @@ export interface BatchLookupPolicy {
|
|
|
945
1048
|
*/
|
|
946
1049
|
export interface BatchReadOperation {
|
|
947
1050
|
/**
|
|
1051
|
+
* @public
|
|
948
1052
|
* <p>Lists all attributes that are associated with an object.</p>
|
|
949
1053
|
*/
|
|
950
1054
|
ListObjectAttributes?: BatchListObjectAttributes;
|
|
951
1055
|
/**
|
|
1056
|
+
* @public
|
|
952
1057
|
* <p>Returns a paginated list of child objects that are associated with a given
|
|
953
1058
|
* object.</p>
|
|
954
1059
|
*/
|
|
955
1060
|
ListObjectChildren?: BatchListObjectChildren;
|
|
956
1061
|
/**
|
|
1062
|
+
* @public
|
|
957
1063
|
* <p>Lists indices attached to an object.</p>
|
|
958
1064
|
*/
|
|
959
1065
|
ListAttachedIndices?: BatchListAttachedIndices;
|
|
960
1066
|
/**
|
|
1067
|
+
* @public
|
|
961
1068
|
* <p>Retrieves all available parent paths for any object type such as node, leaf node,
|
|
962
1069
|
* policy node, and index node objects. For more information about objects, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html">Directory Structure</a>.</p>
|
|
963
1070
|
*/
|
|
964
1071
|
ListObjectParentPaths?: BatchListObjectParentPaths;
|
|
965
1072
|
/**
|
|
1073
|
+
* @public
|
|
966
1074
|
* <p>Retrieves metadata about an object.</p>
|
|
967
1075
|
*/
|
|
968
1076
|
GetObjectInformation?: BatchGetObjectInformation;
|
|
969
1077
|
/**
|
|
1078
|
+
* @public
|
|
970
1079
|
* <p>Retrieves attributes within a facet that are associated with an object.</p>
|
|
971
1080
|
*/
|
|
972
1081
|
GetObjectAttributes?: BatchGetObjectAttributes;
|
|
973
1082
|
/**
|
|
1083
|
+
* @public
|
|
974
1084
|
* <p>Lists parent objects that are associated with a given object in pagination
|
|
975
1085
|
* fashion.</p>
|
|
976
1086
|
*/
|
|
977
1087
|
ListObjectParents?: BatchListObjectParents;
|
|
978
1088
|
/**
|
|
1089
|
+
* @public
|
|
979
1090
|
* <p>Returns policies attached to an object in pagination fashion.</p>
|
|
980
1091
|
*/
|
|
981
1092
|
ListObjectPolicies?: BatchListObjectPolicies;
|
|
982
1093
|
/**
|
|
1094
|
+
* @public
|
|
983
1095
|
* <p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>
|
|
984
1096
|
*/
|
|
985
1097
|
ListPolicyAttachments?: BatchListPolicyAttachments;
|
|
986
1098
|
/**
|
|
1099
|
+
* @public
|
|
987
1100
|
* <p>Lists all policies from the root of the <a>Directory</a> to the object
|
|
988
1101
|
* specified. If there are no policies present, an empty list is returned. If policies are
|
|
989
1102
|
* present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code>
|
|
@@ -993,22 +1106,26 @@ export interface BatchReadOperation {
|
|
|
993
1106
|
*/
|
|
994
1107
|
LookupPolicy?: BatchLookupPolicy;
|
|
995
1108
|
/**
|
|
1109
|
+
* @public
|
|
996
1110
|
* <p>Lists objects attached to the specified index.</p>
|
|
997
1111
|
*/
|
|
998
1112
|
ListIndex?: BatchListIndex;
|
|
999
1113
|
/**
|
|
1114
|
+
* @public
|
|
1000
1115
|
* <p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a>
|
|
1001
1116
|
* information for an object. It also supports filtering by typed link facet and identity
|
|
1002
1117
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1003
1118
|
*/
|
|
1004
1119
|
ListOutgoingTypedLinks?: BatchListOutgoingTypedLinks;
|
|
1005
1120
|
/**
|
|
1121
|
+
* @public
|
|
1006
1122
|
* <p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a>
|
|
1007
1123
|
* information for an object. It also supports filtering by typed link facet and identity
|
|
1008
1124
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1009
1125
|
*/
|
|
1010
1126
|
ListIncomingTypedLinks?: BatchListIncomingTypedLinks;
|
|
1011
1127
|
/**
|
|
1128
|
+
* @public
|
|
1012
1129
|
* <p>Retrieves attributes that are associated with a typed link.</p>
|
|
1013
1130
|
*/
|
|
1014
1131
|
GetLinkAttributes?: BatchGetLinkAttributes;
|
|
@@ -1018,15 +1135,18 @@ export interface BatchReadOperation {
|
|
|
1018
1135
|
*/
|
|
1019
1136
|
export interface BatchReadRequest {
|
|
1020
1137
|
/**
|
|
1138
|
+
* @public
|
|
1021
1139
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>.
|
|
1022
1140
|
* For more information, see <a>arns</a>.</p>
|
|
1023
1141
|
*/
|
|
1024
1142
|
DirectoryArn: string | undefined;
|
|
1025
1143
|
/**
|
|
1144
|
+
* @public
|
|
1026
1145
|
* <p>A list of operations that are part of the batch.</p>
|
|
1027
1146
|
*/
|
|
1028
1147
|
Operations: BatchReadOperation[] | undefined;
|
|
1029
1148
|
/**
|
|
1149
|
+
* @public
|
|
1030
1150
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
1031
1151
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
1032
1152
|
*/
|
|
@@ -1062,10 +1182,12 @@ export type BatchReadExceptionType = (typeof BatchReadExceptionType)[keyof typeo
|
|
|
1062
1182
|
*/
|
|
1063
1183
|
export interface BatchReadException {
|
|
1064
1184
|
/**
|
|
1185
|
+
* @public
|
|
1065
1186
|
* <p>A type of exception, such as <code>InvalidArnException</code>.</p>
|
|
1066
1187
|
*/
|
|
1067
1188
|
Type?: BatchReadExceptionType | string;
|
|
1068
1189
|
/**
|
|
1190
|
+
* @public
|
|
1069
1191
|
* <p>An exception message that is associated with the failure.</p>
|
|
1070
1192
|
*/
|
|
1071
1193
|
Message?: string;
|
|
@@ -1076,6 +1198,7 @@ export interface BatchReadException {
|
|
|
1076
1198
|
*/
|
|
1077
1199
|
export interface BatchGetLinkAttributesResponse {
|
|
1078
1200
|
/**
|
|
1201
|
+
* @public
|
|
1079
1202
|
* <p>The attributes that are associated with the typed link.</p>
|
|
1080
1203
|
*/
|
|
1081
1204
|
Attributes?: AttributeKeyAndValue[];
|
|
@@ -1086,6 +1209,7 @@ export interface BatchGetLinkAttributesResponse {
|
|
|
1086
1209
|
*/
|
|
1087
1210
|
export interface BatchGetObjectAttributesResponse {
|
|
1088
1211
|
/**
|
|
1212
|
+
* @public
|
|
1089
1213
|
* <p>The attribute values that are associated with an object.</p>
|
|
1090
1214
|
*/
|
|
1091
1215
|
Attributes?: AttributeKeyAndValue[];
|
|
@@ -1096,10 +1220,12 @@ export interface BatchGetObjectAttributesResponse {
|
|
|
1096
1220
|
*/
|
|
1097
1221
|
export interface BatchGetObjectInformationResponse {
|
|
1098
1222
|
/**
|
|
1223
|
+
* @public
|
|
1099
1224
|
* <p>The facets attached to the specified object.</p>
|
|
1100
1225
|
*/
|
|
1101
1226
|
SchemaFacets?: SchemaFacet[];
|
|
1102
1227
|
/**
|
|
1228
|
+
* @public
|
|
1103
1229
|
* <p>The <code>ObjectIdentifier</code> of the specified object.</p>
|
|
1104
1230
|
*/
|
|
1105
1231
|
ObjectIdentifier?: string;
|
|
@@ -1110,10 +1236,12 @@ export interface BatchGetObjectInformationResponse {
|
|
|
1110
1236
|
*/
|
|
1111
1237
|
export interface IndexAttachment {
|
|
1112
1238
|
/**
|
|
1239
|
+
* @public
|
|
1113
1240
|
* <p>The indexed attribute values.</p>
|
|
1114
1241
|
*/
|
|
1115
1242
|
IndexedAttributes?: AttributeKeyAndValue[];
|
|
1116
1243
|
/**
|
|
1244
|
+
* @public
|
|
1117
1245
|
* <p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>
|
|
1118
1246
|
*/
|
|
1119
1247
|
ObjectIdentifier?: string;
|
|
@@ -1124,10 +1252,12 @@ export interface IndexAttachment {
|
|
|
1124
1252
|
*/
|
|
1125
1253
|
export interface BatchListAttachedIndicesResponse {
|
|
1126
1254
|
/**
|
|
1255
|
+
* @public
|
|
1127
1256
|
* <p>The indices attached to the specified object.</p>
|
|
1128
1257
|
*/
|
|
1129
1258
|
IndexAttachments?: IndexAttachment[];
|
|
1130
1259
|
/**
|
|
1260
|
+
* @public
|
|
1131
1261
|
* <p>The pagination token.</p>
|
|
1132
1262
|
*/
|
|
1133
1263
|
NextToken?: string;
|
|
@@ -1138,10 +1268,12 @@ export interface BatchListAttachedIndicesResponse {
|
|
|
1138
1268
|
*/
|
|
1139
1269
|
export interface BatchListIncomingTypedLinksResponse {
|
|
1140
1270
|
/**
|
|
1271
|
+
* @public
|
|
1141
1272
|
* <p>Returns one or more typed link specifiers as output.</p>
|
|
1142
1273
|
*/
|
|
1143
1274
|
LinkSpecifiers?: TypedLinkSpecifier[];
|
|
1144
1275
|
/**
|
|
1276
|
+
* @public
|
|
1145
1277
|
* <p>The pagination token.</p>
|
|
1146
1278
|
*/
|
|
1147
1279
|
NextToken?: string;
|
|
@@ -1152,10 +1284,12 @@ export interface BatchListIncomingTypedLinksResponse {
|
|
|
1152
1284
|
*/
|
|
1153
1285
|
export interface BatchListIndexResponse {
|
|
1154
1286
|
/**
|
|
1287
|
+
* @public
|
|
1155
1288
|
* <p>The objects and indexed values attached to the index.</p>
|
|
1156
1289
|
*/
|
|
1157
1290
|
IndexAttachments?: IndexAttachment[];
|
|
1158
1291
|
/**
|
|
1292
|
+
* @public
|
|
1159
1293
|
* <p>The pagination token.</p>
|
|
1160
1294
|
*/
|
|
1161
1295
|
NextToken?: string;
|
|
@@ -1166,11 +1300,13 @@ export interface BatchListIndexResponse {
|
|
|
1166
1300
|
*/
|
|
1167
1301
|
export interface BatchListObjectAttributesResponse {
|
|
1168
1302
|
/**
|
|
1303
|
+
* @public
|
|
1169
1304
|
* <p>The attributes map that is associated with the object. <code>AttributeArn</code> is the
|
|
1170
1305
|
* key; attribute value is the value.</p>
|
|
1171
1306
|
*/
|
|
1172
1307
|
Attributes?: AttributeKeyAndValue[];
|
|
1173
1308
|
/**
|
|
1309
|
+
* @public
|
|
1174
1310
|
* <p>The pagination token.</p>
|
|
1175
1311
|
*/
|
|
1176
1312
|
NextToken?: string;
|
|
@@ -1181,11 +1317,13 @@ export interface BatchListObjectAttributesResponse {
|
|
|
1181
1317
|
*/
|
|
1182
1318
|
export interface BatchListObjectChildrenResponse {
|
|
1183
1319
|
/**
|
|
1320
|
+
* @public
|
|
1184
1321
|
* <p>The children structure, which is a map with the key as the <code>LinkName</code> and
|
|
1185
1322
|
* <code>ObjectIdentifier</code> as the value.</p>
|
|
1186
1323
|
*/
|
|
1187
1324
|
Children?: Record<string, string>;
|
|
1188
1325
|
/**
|
|
1326
|
+
* @public
|
|
1189
1327
|
* <p>The pagination token.</p>
|
|
1190
1328
|
*/
|
|
1191
1329
|
NextToken?: string;
|
|
@@ -1197,10 +1335,12 @@ export interface BatchListObjectChildrenResponse {
|
|
|
1197
1335
|
*/
|
|
1198
1336
|
export interface PathToObjectIdentifiers {
|
|
1199
1337
|
/**
|
|
1338
|
+
* @public
|
|
1200
1339
|
* <p>The path that is used to identify the object starting from directory root.</p>
|
|
1201
1340
|
*/
|
|
1202
1341
|
Path?: string;
|
|
1203
1342
|
/**
|
|
1343
|
+
* @public
|
|
1204
1344
|
* <p>Lists <code>ObjectIdentifiers</code> starting from directory root to the object in the
|
|
1205
1345
|
* request.</p>
|
|
1206
1346
|
*/
|
|
@@ -1212,11 +1352,13 @@ export interface PathToObjectIdentifiers {
|
|
|
1212
1352
|
*/
|
|
1213
1353
|
export interface BatchListObjectParentPathsResponse {
|
|
1214
1354
|
/**
|
|
1355
|
+
* @public
|
|
1215
1356
|
* <p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the
|
|
1216
1357
|
* directory.</p>
|
|
1217
1358
|
*/
|
|
1218
1359
|
PathToObjectIdentifiersList?: PathToObjectIdentifiers[];
|
|
1219
1360
|
/**
|
|
1361
|
+
* @public
|
|
1220
1362
|
* <p>The pagination token.</p>
|
|
1221
1363
|
*/
|
|
1222
1364
|
NextToken?: string;
|
|
@@ -1227,10 +1369,12 @@ export interface BatchListObjectParentPathsResponse {
|
|
|
1227
1369
|
*/
|
|
1228
1370
|
export interface ObjectIdentifierAndLinkNameTuple {
|
|
1229
1371
|
/**
|
|
1372
|
+
* @public
|
|
1230
1373
|
* <p>The ID that is associated with the object.</p>
|
|
1231
1374
|
*/
|
|
1232
1375
|
ObjectIdentifier?: string;
|
|
1233
1376
|
/**
|
|
1377
|
+
* @public
|
|
1234
1378
|
* <p>The name of the link between the parent and the child object.</p>
|
|
1235
1379
|
*/
|
|
1236
1380
|
LinkName?: string;
|
|
@@ -1241,10 +1385,12 @@ export interface ObjectIdentifierAndLinkNameTuple {
|
|
|
1241
1385
|
*/
|
|
1242
1386
|
export interface BatchListObjectParentsResponse {
|
|
1243
1387
|
/**
|
|
1388
|
+
* @public
|
|
1244
1389
|
* <p>Returns a list of parent reference and LinkName Tuples.</p>
|
|
1245
1390
|
*/
|
|
1246
1391
|
ParentLinks?: ObjectIdentifierAndLinkNameTuple[];
|
|
1247
1392
|
/**
|
|
1393
|
+
* @public
|
|
1248
1394
|
* <p>The pagination token.</p>
|
|
1249
1395
|
*/
|
|
1250
1396
|
NextToken?: string;
|
|
@@ -1255,11 +1401,13 @@ export interface BatchListObjectParentsResponse {
|
|
|
1255
1401
|
*/
|
|
1256
1402
|
export interface BatchListObjectPoliciesResponse {
|
|
1257
1403
|
/**
|
|
1404
|
+
* @public
|
|
1258
1405
|
* <p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the
|
|
1259
1406
|
* object.</p>
|
|
1260
1407
|
*/
|
|
1261
1408
|
AttachedPolicyIds?: string[];
|
|
1262
1409
|
/**
|
|
1410
|
+
* @public
|
|
1263
1411
|
* <p>The pagination token.</p>
|
|
1264
1412
|
*/
|
|
1265
1413
|
NextToken?: string;
|
|
@@ -1270,10 +1418,12 @@ export interface BatchListObjectPoliciesResponse {
|
|
|
1270
1418
|
*/
|
|
1271
1419
|
export interface BatchListOutgoingTypedLinksResponse {
|
|
1272
1420
|
/**
|
|
1421
|
+
* @public
|
|
1273
1422
|
* <p>Returns a typed link specifier as output.</p>
|
|
1274
1423
|
*/
|
|
1275
1424
|
TypedLinkSpecifiers?: TypedLinkSpecifier[];
|
|
1276
1425
|
/**
|
|
1426
|
+
* @public
|
|
1277
1427
|
* <p>The pagination token.</p>
|
|
1278
1428
|
*/
|
|
1279
1429
|
NextToken?: string;
|
|
@@ -1284,10 +1434,12 @@ export interface BatchListOutgoingTypedLinksResponse {
|
|
|
1284
1434
|
*/
|
|
1285
1435
|
export interface BatchListPolicyAttachmentsResponse {
|
|
1286
1436
|
/**
|
|
1437
|
+
* @public
|
|
1287
1438
|
* <p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>
|
|
1288
1439
|
*/
|
|
1289
1440
|
ObjectIdentifiers?: string[];
|
|
1290
1441
|
/**
|
|
1442
|
+
* @public
|
|
1291
1443
|
* <p>The pagination token.</p>
|
|
1292
1444
|
*/
|
|
1293
1445
|
NextToken?: string;
|
|
@@ -1300,15 +1452,18 @@ export interface BatchListPolicyAttachmentsResponse {
|
|
|
1300
1452
|
*/
|
|
1301
1453
|
export interface PolicyAttachment {
|
|
1302
1454
|
/**
|
|
1455
|
+
* @public
|
|
1303
1456
|
* <p>The ID of <code>PolicyAttachment</code>.</p>
|
|
1304
1457
|
*/
|
|
1305
1458
|
PolicyId?: string;
|
|
1306
1459
|
/**
|
|
1460
|
+
* @public
|
|
1307
1461
|
* <p>The <code>ObjectIdentifier</code> that is associated with
|
|
1308
1462
|
* <code>PolicyAttachment</code>.</p>
|
|
1309
1463
|
*/
|
|
1310
1464
|
ObjectIdentifier?: string;
|
|
1311
1465
|
/**
|
|
1466
|
+
* @public
|
|
1312
1467
|
* <p>The type of policy that can be associated with <code>PolicyAttachment</code>.</p>
|
|
1313
1468
|
*/
|
|
1314
1469
|
PolicyType?: string;
|
|
@@ -1321,10 +1476,12 @@ export interface PolicyAttachment {
|
|
|
1321
1476
|
*/
|
|
1322
1477
|
export interface PolicyToPath {
|
|
1323
1478
|
/**
|
|
1479
|
+
* @public
|
|
1324
1480
|
* <p>The path that is referenced from the root.</p>
|
|
1325
1481
|
*/
|
|
1326
1482
|
Path?: string;
|
|
1327
1483
|
/**
|
|
1484
|
+
* @public
|
|
1328
1485
|
* <p>List of policy objects.</p>
|
|
1329
1486
|
*/
|
|
1330
1487
|
Policies?: PolicyAttachment[];
|
|
@@ -1335,12 +1492,14 @@ export interface PolicyToPath {
|
|
|
1335
1492
|
*/
|
|
1336
1493
|
export interface BatchLookupPolicyResponse {
|
|
1337
1494
|
/**
|
|
1495
|
+
* @public
|
|
1338
1496
|
* <p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and
|
|
1339
1497
|
* <code>PolicyType</code>. For more
|
|
1340
1498
|
* information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</p>
|
|
1341
1499
|
*/
|
|
1342
1500
|
PolicyToPathList?: PolicyToPath[];
|
|
1343
1501
|
/**
|
|
1502
|
+
* @public
|
|
1344
1503
|
* <p>The pagination token.</p>
|
|
1345
1504
|
*/
|
|
1346
1505
|
NextToken?: string;
|
|
@@ -1351,40 +1510,49 @@ export interface BatchLookupPolicyResponse {
|
|
|
1351
1510
|
*/
|
|
1352
1511
|
export interface BatchReadSuccessfulResponse {
|
|
1353
1512
|
/**
|
|
1513
|
+
* @public
|
|
1354
1514
|
* <p>Lists all attributes that are associated with an object.</p>
|
|
1355
1515
|
*/
|
|
1356
1516
|
ListObjectAttributes?: BatchListObjectAttributesResponse;
|
|
1357
1517
|
/**
|
|
1518
|
+
* @public
|
|
1358
1519
|
* <p>Returns a paginated list of child objects that are associated with a given
|
|
1359
1520
|
* object.</p>
|
|
1360
1521
|
*/
|
|
1361
1522
|
ListObjectChildren?: BatchListObjectChildrenResponse;
|
|
1362
1523
|
/**
|
|
1524
|
+
* @public
|
|
1363
1525
|
* <p>Retrieves metadata about an object.</p>
|
|
1364
1526
|
*/
|
|
1365
1527
|
GetObjectInformation?: BatchGetObjectInformationResponse;
|
|
1366
1528
|
/**
|
|
1529
|
+
* @public
|
|
1367
1530
|
* <p>Retrieves attributes within a facet that are associated with an object.</p>
|
|
1368
1531
|
*/
|
|
1369
1532
|
GetObjectAttributes?: BatchGetObjectAttributesResponse;
|
|
1370
1533
|
/**
|
|
1534
|
+
* @public
|
|
1371
1535
|
* <p>Lists indices attached to an object.</p>
|
|
1372
1536
|
*/
|
|
1373
1537
|
ListAttachedIndices?: BatchListAttachedIndicesResponse;
|
|
1374
1538
|
/**
|
|
1539
|
+
* @public
|
|
1375
1540
|
* <p>Retrieves all available parent paths for any object type such as node, leaf node,
|
|
1376
1541
|
* policy node, and index node objects. For more information about objects, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html">Directory Structure</a>.</p>
|
|
1377
1542
|
*/
|
|
1378
1543
|
ListObjectParentPaths?: BatchListObjectParentPathsResponse;
|
|
1379
1544
|
/**
|
|
1545
|
+
* @public
|
|
1380
1546
|
* <p>Returns policies attached to an object in pagination fashion.</p>
|
|
1381
1547
|
*/
|
|
1382
1548
|
ListObjectPolicies?: BatchListObjectPoliciesResponse;
|
|
1383
1549
|
/**
|
|
1550
|
+
* @public
|
|
1384
1551
|
* <p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>
|
|
1385
1552
|
*/
|
|
1386
1553
|
ListPolicyAttachments?: BatchListPolicyAttachmentsResponse;
|
|
1387
1554
|
/**
|
|
1555
|
+
* @public
|
|
1388
1556
|
* <p>Lists all policies from the root of the <a>Directory</a> to the object
|
|
1389
1557
|
* specified. If there are no policies present, an empty list is returned. If policies are
|
|
1390
1558
|
* present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code>
|
|
@@ -1394,26 +1562,31 @@ export interface BatchReadSuccessfulResponse {
|
|
|
1394
1562
|
*/
|
|
1395
1563
|
LookupPolicy?: BatchLookupPolicyResponse;
|
|
1396
1564
|
/**
|
|
1565
|
+
* @public
|
|
1397
1566
|
* <p>Lists objects attached to the specified index.</p>
|
|
1398
1567
|
*/
|
|
1399
1568
|
ListIndex?: BatchListIndexResponse;
|
|
1400
1569
|
/**
|
|
1570
|
+
* @public
|
|
1401
1571
|
* <p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a>
|
|
1402
1572
|
* information for an object. It also supports filtering by typed link facet and identity
|
|
1403
1573
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1404
1574
|
*/
|
|
1405
1575
|
ListOutgoingTypedLinks?: BatchListOutgoingTypedLinksResponse;
|
|
1406
1576
|
/**
|
|
1577
|
+
* @public
|
|
1407
1578
|
* <p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a>
|
|
1408
1579
|
* information for an object. It also supports filtering by typed link facet and identity
|
|
1409
1580
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1410
1581
|
*/
|
|
1411
1582
|
ListIncomingTypedLinks?: BatchListIncomingTypedLinksResponse;
|
|
1412
1583
|
/**
|
|
1584
|
+
* @public
|
|
1413
1585
|
* <p>The list of attributes to retrieve from the typed link.</p>
|
|
1414
1586
|
*/
|
|
1415
1587
|
GetLinkAttributes?: BatchGetLinkAttributesResponse;
|
|
1416
1588
|
/**
|
|
1589
|
+
* @public
|
|
1417
1590
|
* <p>The list of parent objects to retrieve.</p>
|
|
1418
1591
|
*/
|
|
1419
1592
|
ListObjectParents?: BatchListObjectParentsResponse;
|
|
@@ -1424,10 +1597,12 @@ export interface BatchReadSuccessfulResponse {
|
|
|
1424
1597
|
*/
|
|
1425
1598
|
export interface BatchReadOperationResponse {
|
|
1426
1599
|
/**
|
|
1600
|
+
* @public
|
|
1427
1601
|
* <p>Identifies which operation in a batch has succeeded.</p>
|
|
1428
1602
|
*/
|
|
1429
1603
|
SuccessfulResponse?: BatchReadSuccessfulResponse;
|
|
1430
1604
|
/**
|
|
1605
|
+
* @public
|
|
1431
1606
|
* <p>Identifies which operation in a batch has failed.</p>
|
|
1432
1607
|
*/
|
|
1433
1608
|
ExceptionResponse?: BatchReadException;
|
|
@@ -1437,6 +1612,7 @@ export interface BatchReadOperationResponse {
|
|
|
1437
1612
|
*/
|
|
1438
1613
|
export interface BatchReadResponse {
|
|
1439
1614
|
/**
|
|
1615
|
+
* @public
|
|
1440
1616
|
* <p>A list of all the responses for each batch read.</p>
|
|
1441
1617
|
*/
|
|
1442
1618
|
Responses?: BatchReadOperationResponse[];
|
|
@@ -1490,14 +1666,17 @@ export declare class BatchWriteException extends __BaseException {
|
|
|
1490
1666
|
*/
|
|
1491
1667
|
export interface BatchAddFacetToObject {
|
|
1492
1668
|
/**
|
|
1669
|
+
* @public
|
|
1493
1670
|
* <p>Represents the facet being added to the object.</p>
|
|
1494
1671
|
*/
|
|
1495
1672
|
SchemaFacet: SchemaFacet | undefined;
|
|
1496
1673
|
/**
|
|
1674
|
+
* @public
|
|
1497
1675
|
* <p>The attributes to set on the object.</p>
|
|
1498
1676
|
*/
|
|
1499
1677
|
ObjectAttributeList: AttributeKeyAndValue[] | undefined;
|
|
1500
1678
|
/**
|
|
1679
|
+
* @public
|
|
1501
1680
|
* <p>A reference to the object being mutated.</p>
|
|
1502
1681
|
*/
|
|
1503
1682
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -1508,14 +1687,17 @@ export interface BatchAddFacetToObject {
|
|
|
1508
1687
|
*/
|
|
1509
1688
|
export interface BatchAttachObject {
|
|
1510
1689
|
/**
|
|
1690
|
+
* @public
|
|
1511
1691
|
* <p>The parent object reference.</p>
|
|
1512
1692
|
*/
|
|
1513
1693
|
ParentReference: ObjectReference | undefined;
|
|
1514
1694
|
/**
|
|
1695
|
+
* @public
|
|
1515
1696
|
* <p>The child object reference that is to be attached to the object.</p>
|
|
1516
1697
|
*/
|
|
1517
1698
|
ChildReference: ObjectReference | undefined;
|
|
1518
1699
|
/**
|
|
1700
|
+
* @public
|
|
1519
1701
|
* <p>The name of the link.</p>
|
|
1520
1702
|
*/
|
|
1521
1703
|
LinkName: string | undefined;
|
|
@@ -1526,10 +1708,12 @@ export interface BatchAttachObject {
|
|
|
1526
1708
|
*/
|
|
1527
1709
|
export interface BatchAttachPolicy {
|
|
1528
1710
|
/**
|
|
1711
|
+
* @public
|
|
1529
1712
|
* <p>The reference that is associated with the policy object.</p>
|
|
1530
1713
|
*/
|
|
1531
1714
|
PolicyReference: ObjectReference | undefined;
|
|
1532
1715
|
/**
|
|
1716
|
+
* @public
|
|
1533
1717
|
* <p>The reference that identifies the object to which the policy will be
|
|
1534
1718
|
* attached.</p>
|
|
1535
1719
|
*/
|
|
@@ -1541,10 +1725,12 @@ export interface BatchAttachPolicy {
|
|
|
1541
1725
|
*/
|
|
1542
1726
|
export interface BatchAttachToIndex {
|
|
1543
1727
|
/**
|
|
1728
|
+
* @public
|
|
1544
1729
|
* <p>A reference to the index that you are attaching the object to.</p>
|
|
1545
1730
|
*/
|
|
1546
1731
|
IndexReference: ObjectReference | undefined;
|
|
1547
1732
|
/**
|
|
1733
|
+
* @public
|
|
1548
1734
|
* <p>A reference to the object that you are attaching to the index.</p>
|
|
1549
1735
|
*/
|
|
1550
1736
|
TargetReference: ObjectReference | undefined;
|
|
@@ -1555,18 +1741,22 @@ export interface BatchAttachToIndex {
|
|
|
1555
1741
|
*/
|
|
1556
1742
|
export interface BatchAttachTypedLink {
|
|
1557
1743
|
/**
|
|
1744
|
+
* @public
|
|
1558
1745
|
* <p>Identifies the source object that the typed link will attach to.</p>
|
|
1559
1746
|
*/
|
|
1560
1747
|
SourceObjectReference: ObjectReference | undefined;
|
|
1561
1748
|
/**
|
|
1749
|
+
* @public
|
|
1562
1750
|
* <p>Identifies the target object that the typed link will attach to.</p>
|
|
1563
1751
|
*/
|
|
1564
1752
|
TargetObjectReference: ObjectReference | undefined;
|
|
1565
1753
|
/**
|
|
1754
|
+
* @public
|
|
1566
1755
|
* <p>Identifies the typed link facet that is associated with the typed link.</p>
|
|
1567
1756
|
*/
|
|
1568
1757
|
TypedLinkFacet: TypedLinkSchemaAndFacetName | undefined;
|
|
1569
1758
|
/**
|
|
1759
|
+
* @public
|
|
1570
1760
|
* <p>A set of attributes that are associated with the typed link.</p>
|
|
1571
1761
|
*/
|
|
1572
1762
|
Attributes: AttributeNameAndValue[] | undefined;
|
|
@@ -1577,24 +1767,29 @@ export interface BatchAttachTypedLink {
|
|
|
1577
1767
|
*/
|
|
1578
1768
|
export interface BatchCreateIndex {
|
|
1579
1769
|
/**
|
|
1770
|
+
* @public
|
|
1580
1771
|
* <p>Specifies the attributes that should be indexed on. Currently only a single attribute
|
|
1581
1772
|
* is supported.</p>
|
|
1582
1773
|
*/
|
|
1583
1774
|
OrderedIndexedAttributeList: AttributeKey[] | undefined;
|
|
1584
1775
|
/**
|
|
1776
|
+
* @public
|
|
1585
1777
|
* <p>Indicates whether the attribute that is being indexed has unique values or
|
|
1586
1778
|
* not.</p>
|
|
1587
1779
|
*/
|
|
1588
1780
|
IsUnique: boolean | undefined;
|
|
1589
1781
|
/**
|
|
1782
|
+
* @public
|
|
1590
1783
|
* <p>A reference to the parent object that contains the index object.</p>
|
|
1591
1784
|
*/
|
|
1592
1785
|
ParentReference?: ObjectReference;
|
|
1593
1786
|
/**
|
|
1787
|
+
* @public
|
|
1594
1788
|
* <p>The name of the link between the parent object and the index object.</p>
|
|
1595
1789
|
*/
|
|
1596
1790
|
LinkName?: string;
|
|
1597
1791
|
/**
|
|
1792
|
+
* @public
|
|
1598
1793
|
* <p>The batch reference name. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html">Transaction Support</a> for more information.</p>
|
|
1599
1794
|
*/
|
|
1600
1795
|
BatchReferenceName?: string;
|
|
@@ -1605,24 +1800,29 @@ export interface BatchCreateIndex {
|
|
|
1605
1800
|
*/
|
|
1606
1801
|
export interface BatchCreateObject {
|
|
1607
1802
|
/**
|
|
1803
|
+
* @public
|
|
1608
1804
|
* <p>A list of <code>FacetArns</code> that will be associated with the object. For more
|
|
1609
1805
|
* information, see <a>arns</a>.</p>
|
|
1610
1806
|
*/
|
|
1611
1807
|
SchemaFacet: SchemaFacet[] | undefined;
|
|
1612
1808
|
/**
|
|
1809
|
+
* @public
|
|
1613
1810
|
* <p>An attribute map, which contains an attribute ARN as the key and attribute value as
|
|
1614
1811
|
* the map value.</p>
|
|
1615
1812
|
*/
|
|
1616
1813
|
ObjectAttributeList: AttributeKeyAndValue[] | undefined;
|
|
1617
1814
|
/**
|
|
1815
|
+
* @public
|
|
1618
1816
|
* <p>If specified, the parent reference to which this object will be attached.</p>
|
|
1619
1817
|
*/
|
|
1620
1818
|
ParentReference?: ObjectReference;
|
|
1621
1819
|
/**
|
|
1820
|
+
* @public
|
|
1622
1821
|
* <p>The name of the link.</p>
|
|
1623
1822
|
*/
|
|
1624
1823
|
LinkName?: string;
|
|
1625
1824
|
/**
|
|
1825
|
+
* @public
|
|
1626
1826
|
* <p>The batch reference name. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html">Transaction Support</a> for more information.</p>
|
|
1627
1827
|
*/
|
|
1628
1828
|
BatchReferenceName?: string;
|
|
@@ -1633,6 +1833,7 @@ export interface BatchCreateObject {
|
|
|
1633
1833
|
*/
|
|
1634
1834
|
export interface BatchDeleteObject {
|
|
1635
1835
|
/**
|
|
1836
|
+
* @public
|
|
1636
1837
|
* <p>The reference that identifies the object.</p>
|
|
1637
1838
|
*/
|
|
1638
1839
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -1643,10 +1844,12 @@ export interface BatchDeleteObject {
|
|
|
1643
1844
|
*/
|
|
1644
1845
|
export interface BatchDetachFromIndex {
|
|
1645
1846
|
/**
|
|
1847
|
+
* @public
|
|
1646
1848
|
* <p>A reference to the index object.</p>
|
|
1647
1849
|
*/
|
|
1648
1850
|
IndexReference: ObjectReference | undefined;
|
|
1649
1851
|
/**
|
|
1852
|
+
* @public
|
|
1650
1853
|
* <p>A reference to the object being detached from the index.</p>
|
|
1651
1854
|
*/
|
|
1652
1855
|
TargetReference: ObjectReference | undefined;
|
|
@@ -1657,15 +1860,18 @@ export interface BatchDetachFromIndex {
|
|
|
1657
1860
|
*/
|
|
1658
1861
|
export interface BatchDetachObject {
|
|
1659
1862
|
/**
|
|
1863
|
+
* @public
|
|
1660
1864
|
* <p>Parent reference from which the object with the specified link name is
|
|
1661
1865
|
* detached.</p>
|
|
1662
1866
|
*/
|
|
1663
1867
|
ParentReference: ObjectReference | undefined;
|
|
1664
1868
|
/**
|
|
1869
|
+
* @public
|
|
1665
1870
|
* <p>The name of the link.</p>
|
|
1666
1871
|
*/
|
|
1667
1872
|
LinkName: string | undefined;
|
|
1668
1873
|
/**
|
|
1874
|
+
* @public
|
|
1669
1875
|
* <p>The batch reference name. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html">Transaction Support</a> for more information.</p>
|
|
1670
1876
|
*/
|
|
1671
1877
|
BatchReferenceName?: string;
|
|
@@ -1676,10 +1882,12 @@ export interface BatchDetachObject {
|
|
|
1676
1882
|
*/
|
|
1677
1883
|
export interface BatchDetachPolicy {
|
|
1678
1884
|
/**
|
|
1885
|
+
* @public
|
|
1679
1886
|
* <p>Reference that identifies the policy object.</p>
|
|
1680
1887
|
*/
|
|
1681
1888
|
PolicyReference: ObjectReference | undefined;
|
|
1682
1889
|
/**
|
|
1890
|
+
* @public
|
|
1683
1891
|
* <p>Reference that identifies the object whose policy object will be detached.</p>
|
|
1684
1892
|
*/
|
|
1685
1893
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -1690,6 +1898,7 @@ export interface BatchDetachPolicy {
|
|
|
1690
1898
|
*/
|
|
1691
1899
|
export interface BatchDetachTypedLink {
|
|
1692
1900
|
/**
|
|
1901
|
+
* @public
|
|
1693
1902
|
* <p>Used to accept a typed link specifier as input.</p>
|
|
1694
1903
|
*/
|
|
1695
1904
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
@@ -1700,10 +1909,12 @@ export interface BatchDetachTypedLink {
|
|
|
1700
1909
|
*/
|
|
1701
1910
|
export interface BatchRemoveFacetFromObject {
|
|
1702
1911
|
/**
|
|
1912
|
+
* @public
|
|
1703
1913
|
* <p>The facet to remove from the object.</p>
|
|
1704
1914
|
*/
|
|
1705
1915
|
SchemaFacet: SchemaFacet | undefined;
|
|
1706
1916
|
/**
|
|
1917
|
+
* @public
|
|
1707
1918
|
* <p>A reference to the object whose facet will be removed.</p>
|
|
1708
1919
|
*/
|
|
1709
1920
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -1726,10 +1937,12 @@ export type UpdateActionType = (typeof UpdateActionType)[keyof typeof UpdateActi
|
|
|
1726
1937
|
*/
|
|
1727
1938
|
export interface LinkAttributeAction {
|
|
1728
1939
|
/**
|
|
1940
|
+
* @public
|
|
1729
1941
|
* <p>A type that can be either <code>UPDATE_OR_CREATE</code> or <code>DELETE</code>.</p>
|
|
1730
1942
|
*/
|
|
1731
1943
|
AttributeActionType?: UpdateActionType | string;
|
|
1732
1944
|
/**
|
|
1945
|
+
* @public
|
|
1733
1946
|
* <p>The value that you want to update to.</p>
|
|
1734
1947
|
*/
|
|
1735
1948
|
AttributeUpdateValue?: TypedAttributeValue;
|
|
@@ -1740,10 +1953,12 @@ export interface LinkAttributeAction {
|
|
|
1740
1953
|
*/
|
|
1741
1954
|
export interface LinkAttributeUpdate {
|
|
1742
1955
|
/**
|
|
1956
|
+
* @public
|
|
1743
1957
|
* <p>The key of the attribute being updated.</p>
|
|
1744
1958
|
*/
|
|
1745
1959
|
AttributeKey?: AttributeKey;
|
|
1746
1960
|
/**
|
|
1961
|
+
* @public
|
|
1747
1962
|
* <p>The action to perform as part of the attribute update.</p>
|
|
1748
1963
|
*/
|
|
1749
1964
|
AttributeAction?: LinkAttributeAction;
|
|
@@ -1754,10 +1969,12 @@ export interface LinkAttributeUpdate {
|
|
|
1754
1969
|
*/
|
|
1755
1970
|
export interface BatchUpdateLinkAttributes {
|
|
1756
1971
|
/**
|
|
1972
|
+
* @public
|
|
1757
1973
|
* <p>Allows a typed link specifier to be accepted as input.</p>
|
|
1758
1974
|
*/
|
|
1759
1975
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
1760
1976
|
/**
|
|
1977
|
+
* @public
|
|
1761
1978
|
* <p>The attributes update structure.</p>
|
|
1762
1979
|
*/
|
|
1763
1980
|
AttributeUpdates: LinkAttributeUpdate[] | undefined;
|
|
@@ -1768,10 +1985,12 @@ export interface BatchUpdateLinkAttributes {
|
|
|
1768
1985
|
*/
|
|
1769
1986
|
export interface ObjectAttributeAction {
|
|
1770
1987
|
/**
|
|
1988
|
+
* @public
|
|
1771
1989
|
* <p>A type that can be either <code>Update</code> or <code>Delete</code>.</p>
|
|
1772
1990
|
*/
|
|
1773
1991
|
ObjectAttributeActionType?: UpdateActionType | string;
|
|
1774
1992
|
/**
|
|
1993
|
+
* @public
|
|
1775
1994
|
* <p>The value that you want to update to.</p>
|
|
1776
1995
|
*/
|
|
1777
1996
|
ObjectAttributeUpdateValue?: TypedAttributeValue;
|
|
@@ -1782,10 +2001,12 @@ export interface ObjectAttributeAction {
|
|
|
1782
2001
|
*/
|
|
1783
2002
|
export interface ObjectAttributeUpdate {
|
|
1784
2003
|
/**
|
|
2004
|
+
* @public
|
|
1785
2005
|
* <p>The key of the attribute being updated.</p>
|
|
1786
2006
|
*/
|
|
1787
2007
|
ObjectAttributeKey?: AttributeKey;
|
|
1788
2008
|
/**
|
|
2009
|
+
* @public
|
|
1789
2010
|
* <p>The action to perform as part of the attribute update.</p>
|
|
1790
2011
|
*/
|
|
1791
2012
|
ObjectAttributeAction?: ObjectAttributeAction;
|
|
@@ -1796,10 +2017,12 @@ export interface ObjectAttributeUpdate {
|
|
|
1796
2017
|
*/
|
|
1797
2018
|
export interface BatchUpdateObjectAttributes {
|
|
1798
2019
|
/**
|
|
2020
|
+
* @public
|
|
1799
2021
|
* <p>Reference that identifies the object.</p>
|
|
1800
2022
|
*/
|
|
1801
2023
|
ObjectReference: ObjectReference | undefined;
|
|
1802
2024
|
/**
|
|
2025
|
+
* @public
|
|
1803
2026
|
* <p>Attributes update structure.</p>
|
|
1804
2027
|
*/
|
|
1805
2028
|
AttributeUpdates: ObjectAttributeUpdate[] | undefined;
|
|
@@ -1810,63 +2033,78 @@ export interface BatchUpdateObjectAttributes {
|
|
|
1810
2033
|
*/
|
|
1811
2034
|
export interface BatchWriteOperation {
|
|
1812
2035
|
/**
|
|
2036
|
+
* @public
|
|
1813
2037
|
* <p>Creates an object.</p>
|
|
1814
2038
|
*/
|
|
1815
2039
|
CreateObject?: BatchCreateObject;
|
|
1816
2040
|
/**
|
|
2041
|
+
* @public
|
|
1817
2042
|
* <p>Attaches an object to a <a>Directory</a>.</p>
|
|
1818
2043
|
*/
|
|
1819
2044
|
AttachObject?: BatchAttachObject;
|
|
1820
2045
|
/**
|
|
2046
|
+
* @public
|
|
1821
2047
|
* <p>Detaches an object from a <a>Directory</a>.</p>
|
|
1822
2048
|
*/
|
|
1823
2049
|
DetachObject?: BatchDetachObject;
|
|
1824
2050
|
/**
|
|
2051
|
+
* @public
|
|
1825
2052
|
* <p>Updates a given object's attributes.</p>
|
|
1826
2053
|
*/
|
|
1827
2054
|
UpdateObjectAttributes?: BatchUpdateObjectAttributes;
|
|
1828
2055
|
/**
|
|
2056
|
+
* @public
|
|
1829
2057
|
* <p>Deletes an object in a <a>Directory</a>.</p>
|
|
1830
2058
|
*/
|
|
1831
2059
|
DeleteObject?: BatchDeleteObject;
|
|
1832
2060
|
/**
|
|
2061
|
+
* @public
|
|
1833
2062
|
* <p>A batch operation that adds a facet to an object.</p>
|
|
1834
2063
|
*/
|
|
1835
2064
|
AddFacetToObject?: BatchAddFacetToObject;
|
|
1836
2065
|
/**
|
|
2066
|
+
* @public
|
|
1837
2067
|
* <p>A batch operation that removes a facet from an object.</p>
|
|
1838
2068
|
*/
|
|
1839
2069
|
RemoveFacetFromObject?: BatchRemoveFacetFromObject;
|
|
1840
2070
|
/**
|
|
2071
|
+
* @public
|
|
1841
2072
|
* <p>Attaches a policy object to a regular object. An object can have a limited number of attached
|
|
1842
2073
|
* policies.</p>
|
|
1843
2074
|
*/
|
|
1844
2075
|
AttachPolicy?: BatchAttachPolicy;
|
|
1845
2076
|
/**
|
|
2077
|
+
* @public
|
|
1846
2078
|
* <p>Detaches a policy from a <a>Directory</a>.</p>
|
|
1847
2079
|
*/
|
|
1848
2080
|
DetachPolicy?: BatchDetachPolicy;
|
|
1849
2081
|
/**
|
|
2082
|
+
* @public
|
|
1850
2083
|
* <p>Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm">Indexing and search</a> for more information.</p>
|
|
1851
2084
|
*/
|
|
1852
2085
|
CreateIndex?: BatchCreateIndex;
|
|
1853
2086
|
/**
|
|
2087
|
+
* @public
|
|
1854
2088
|
* <p>Attaches the specified object to the specified index.</p>
|
|
1855
2089
|
*/
|
|
1856
2090
|
AttachToIndex?: BatchAttachToIndex;
|
|
1857
2091
|
/**
|
|
2092
|
+
* @public
|
|
1858
2093
|
* <p>Detaches the specified object from the specified index.</p>
|
|
1859
2094
|
*/
|
|
1860
2095
|
DetachFromIndex?: BatchDetachFromIndex;
|
|
1861
2096
|
/**
|
|
2097
|
+
* @public
|
|
1862
2098
|
* <p>Attaches a typed link to a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1863
2099
|
*/
|
|
1864
2100
|
AttachTypedLink?: BatchAttachTypedLink;
|
|
1865
2101
|
/**
|
|
2102
|
+
* @public
|
|
1866
2103
|
* <p>Detaches a typed link from a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
1867
2104
|
*/
|
|
1868
2105
|
DetachTypedLink?: BatchDetachTypedLink;
|
|
1869
2106
|
/**
|
|
2107
|
+
* @public
|
|
1870
2108
|
* <p>Updates a given object's attributes.</p>
|
|
1871
2109
|
*/
|
|
1872
2110
|
UpdateLinkAttributes?: BatchUpdateLinkAttributes;
|
|
@@ -1876,11 +2114,13 @@ export interface BatchWriteOperation {
|
|
|
1876
2114
|
*/
|
|
1877
2115
|
export interface BatchWriteRequest {
|
|
1878
2116
|
/**
|
|
2117
|
+
* @public
|
|
1879
2118
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>.
|
|
1880
2119
|
* For more information, see <a>arns</a>.</p>
|
|
1881
2120
|
*/
|
|
1882
2121
|
DirectoryArn: string | undefined;
|
|
1883
2122
|
/**
|
|
2123
|
+
* @public
|
|
1884
2124
|
* <p>A list of operations that are part of the batch.</p>
|
|
1885
2125
|
*/
|
|
1886
2126
|
Operations: BatchWriteOperation[] | undefined;
|
|
@@ -1897,6 +2137,7 @@ export interface BatchAddFacetToObjectResponse {
|
|
|
1897
2137
|
*/
|
|
1898
2138
|
export interface BatchAttachObjectResponse {
|
|
1899
2139
|
/**
|
|
2140
|
+
* @public
|
|
1900
2141
|
* <p>The <code>ObjectIdentifier</code> of the object that has been attached.</p>
|
|
1901
2142
|
*/
|
|
1902
2143
|
attachedObjectIdentifier?: string;
|
|
@@ -1914,6 +2155,7 @@ export interface BatchAttachPolicyResponse {
|
|
|
1914
2155
|
*/
|
|
1915
2156
|
export interface BatchAttachToIndexResponse {
|
|
1916
2157
|
/**
|
|
2158
|
+
* @public
|
|
1917
2159
|
* <p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>
|
|
1918
2160
|
*/
|
|
1919
2161
|
AttachedObjectIdentifier?: string;
|
|
@@ -1924,6 +2166,7 @@ export interface BatchAttachToIndexResponse {
|
|
|
1924
2166
|
*/
|
|
1925
2167
|
export interface BatchAttachTypedLinkResponse {
|
|
1926
2168
|
/**
|
|
2169
|
+
* @public
|
|
1927
2170
|
* <p>Returns a typed link specifier as output.</p>
|
|
1928
2171
|
*/
|
|
1929
2172
|
TypedLinkSpecifier?: TypedLinkSpecifier;
|
|
@@ -1934,6 +2177,7 @@ export interface BatchAttachTypedLinkResponse {
|
|
|
1934
2177
|
*/
|
|
1935
2178
|
export interface BatchCreateIndexResponse {
|
|
1936
2179
|
/**
|
|
2180
|
+
* @public
|
|
1937
2181
|
* <p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>
|
|
1938
2182
|
*/
|
|
1939
2183
|
ObjectIdentifier?: string;
|
|
@@ -1944,6 +2188,7 @@ export interface BatchCreateIndexResponse {
|
|
|
1944
2188
|
*/
|
|
1945
2189
|
export interface BatchCreateObjectResponse {
|
|
1946
2190
|
/**
|
|
2191
|
+
* @public
|
|
1947
2192
|
* <p>The ID that is associated with the object.</p>
|
|
1948
2193
|
*/
|
|
1949
2194
|
ObjectIdentifier?: string;
|
|
@@ -1960,6 +2205,7 @@ export interface BatchDeleteObjectResponse {
|
|
|
1960
2205
|
*/
|
|
1961
2206
|
export interface BatchDetachFromIndexResponse {
|
|
1962
2207
|
/**
|
|
2208
|
+
* @public
|
|
1963
2209
|
* <p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>
|
|
1964
2210
|
*/
|
|
1965
2211
|
DetachedObjectIdentifier?: string;
|
|
@@ -1970,6 +2216,7 @@ export interface BatchDetachFromIndexResponse {
|
|
|
1970
2216
|
*/
|
|
1971
2217
|
export interface BatchDetachObjectResponse {
|
|
1972
2218
|
/**
|
|
2219
|
+
* @public
|
|
1973
2220
|
* <p>The <code>ObjectIdentifier</code> of the detached object.</p>
|
|
1974
2221
|
*/
|
|
1975
2222
|
detachedObjectIdentifier?: string;
|
|
@@ -2004,6 +2251,7 @@ export interface BatchUpdateLinkAttributesResponse {
|
|
|
2004
2251
|
*/
|
|
2005
2252
|
export interface BatchUpdateObjectAttributesResponse {
|
|
2006
2253
|
/**
|
|
2254
|
+
* @public
|
|
2007
2255
|
* <p>ID that is associated with the object.</p>
|
|
2008
2256
|
*/
|
|
2009
2257
|
ObjectIdentifier?: string;
|
|
@@ -2014,63 +2262,78 @@ export interface BatchUpdateObjectAttributesResponse {
|
|
|
2014
2262
|
*/
|
|
2015
2263
|
export interface BatchWriteOperationResponse {
|
|
2016
2264
|
/**
|
|
2265
|
+
* @public
|
|
2017
2266
|
* <p>Creates an object in a <a>Directory</a>.</p>
|
|
2018
2267
|
*/
|
|
2019
2268
|
CreateObject?: BatchCreateObjectResponse;
|
|
2020
2269
|
/**
|
|
2270
|
+
* @public
|
|
2021
2271
|
* <p>Attaches an object to a <a>Directory</a>.</p>
|
|
2022
2272
|
*/
|
|
2023
2273
|
AttachObject?: BatchAttachObjectResponse;
|
|
2024
2274
|
/**
|
|
2275
|
+
* @public
|
|
2025
2276
|
* <p>Detaches an object from a <a>Directory</a>.</p>
|
|
2026
2277
|
*/
|
|
2027
2278
|
DetachObject?: BatchDetachObjectResponse;
|
|
2028
2279
|
/**
|
|
2280
|
+
* @public
|
|
2029
2281
|
* <p>Updates a given object’s attributes.</p>
|
|
2030
2282
|
*/
|
|
2031
2283
|
UpdateObjectAttributes?: BatchUpdateObjectAttributesResponse;
|
|
2032
2284
|
/**
|
|
2285
|
+
* @public
|
|
2033
2286
|
* <p>Deletes an object in a <a>Directory</a>.</p>
|
|
2034
2287
|
*/
|
|
2035
2288
|
DeleteObject?: BatchDeleteObjectResponse;
|
|
2036
2289
|
/**
|
|
2290
|
+
* @public
|
|
2037
2291
|
* <p>The result of an add facet to object batch operation.</p>
|
|
2038
2292
|
*/
|
|
2039
2293
|
AddFacetToObject?: BatchAddFacetToObjectResponse;
|
|
2040
2294
|
/**
|
|
2295
|
+
* @public
|
|
2041
2296
|
* <p>The result of a batch remove facet from object operation.</p>
|
|
2042
2297
|
*/
|
|
2043
2298
|
RemoveFacetFromObject?: BatchRemoveFacetFromObjectResponse;
|
|
2044
2299
|
/**
|
|
2300
|
+
* @public
|
|
2045
2301
|
* <p>Attaches a policy object to a regular object. An object can have a limited number of attached
|
|
2046
2302
|
* policies.</p>
|
|
2047
2303
|
*/
|
|
2048
2304
|
AttachPolicy?: BatchAttachPolicyResponse;
|
|
2049
2305
|
/**
|
|
2306
|
+
* @public
|
|
2050
2307
|
* <p>Detaches a policy from a <a>Directory</a>.</p>
|
|
2051
2308
|
*/
|
|
2052
2309
|
DetachPolicy?: BatchDetachPolicyResponse;
|
|
2053
2310
|
/**
|
|
2311
|
+
* @public
|
|
2054
2312
|
* <p>Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm">Indexing and search</a> for more information.</p>
|
|
2055
2313
|
*/
|
|
2056
2314
|
CreateIndex?: BatchCreateIndexResponse;
|
|
2057
2315
|
/**
|
|
2316
|
+
* @public
|
|
2058
2317
|
* <p>Attaches the specified object to the specified index.</p>
|
|
2059
2318
|
*/
|
|
2060
2319
|
AttachToIndex?: BatchAttachToIndexResponse;
|
|
2061
2320
|
/**
|
|
2321
|
+
* @public
|
|
2062
2322
|
* <p>Detaches the specified object from the specified index.</p>
|
|
2063
2323
|
*/
|
|
2064
2324
|
DetachFromIndex?: BatchDetachFromIndexResponse;
|
|
2065
2325
|
/**
|
|
2326
|
+
* @public
|
|
2066
2327
|
* <p>Attaches a typed link to a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
2067
2328
|
*/
|
|
2068
2329
|
AttachTypedLink?: BatchAttachTypedLinkResponse;
|
|
2069
2330
|
/**
|
|
2331
|
+
* @public
|
|
2070
2332
|
* <p>Detaches a typed link from a specified source and target object. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
2071
2333
|
*/
|
|
2072
2334
|
DetachTypedLink?: BatchDetachTypedLinkResponse;
|
|
2073
2335
|
/**
|
|
2336
|
+
* @public
|
|
2074
2337
|
* <p>Represents the output of a <code>BatchWrite</code> response operation.</p>
|
|
2075
2338
|
*/
|
|
2076
2339
|
UpdateLinkAttributes?: BatchUpdateLinkAttributesResponse;
|
|
@@ -2080,6 +2343,7 @@ export interface BatchWriteOperationResponse {
|
|
|
2080
2343
|
*/
|
|
2081
2344
|
export interface BatchWriteResponse {
|
|
2082
2345
|
/**
|
|
2346
|
+
* @public
|
|
2083
2347
|
* <p>A list of all the responses for each batch write.</p>
|
|
2084
2348
|
*/
|
|
2085
2349
|
Responses?: BatchWriteOperationResponse[];
|
|
@@ -2089,11 +2353,13 @@ export interface BatchWriteResponse {
|
|
|
2089
2353
|
*/
|
|
2090
2354
|
export interface CreateDirectoryRequest {
|
|
2091
2355
|
/**
|
|
2356
|
+
* @public
|
|
2092
2357
|
* <p>The name of the <a>Directory</a>. Should be unique per account, per
|
|
2093
2358
|
* region.</p>
|
|
2094
2359
|
*/
|
|
2095
2360
|
Name: string | undefined;
|
|
2096
2361
|
/**
|
|
2362
|
+
* @public
|
|
2097
2363
|
* <p>The Amazon Resource Name (ARN) of the published schema that will be copied into the
|
|
2098
2364
|
* data <a>Directory</a>. For more information, see <a>arns</a>.</p>
|
|
2099
2365
|
*/
|
|
@@ -2104,19 +2370,23 @@ export interface CreateDirectoryRequest {
|
|
|
2104
2370
|
*/
|
|
2105
2371
|
export interface CreateDirectoryResponse {
|
|
2106
2372
|
/**
|
|
2373
|
+
* @public
|
|
2107
2374
|
* <p>The ARN that is associated with the <a>Directory</a>. For more information,
|
|
2108
2375
|
* see <a>arns</a>.</p>
|
|
2109
2376
|
*/
|
|
2110
2377
|
DirectoryArn: string | undefined;
|
|
2111
2378
|
/**
|
|
2379
|
+
* @public
|
|
2112
2380
|
* <p>The name of the <a>Directory</a>.</p>
|
|
2113
2381
|
*/
|
|
2114
2382
|
Name: string | undefined;
|
|
2115
2383
|
/**
|
|
2384
|
+
* @public
|
|
2116
2385
|
* <p>The root object node of the created directory.</p>
|
|
2117
2386
|
*/
|
|
2118
2387
|
ObjectIdentifier: string | undefined;
|
|
2119
2388
|
/**
|
|
2389
|
+
* @public
|
|
2120
2390
|
* <p>The ARN of the published schema in the <a>Directory</a>. Once a published
|
|
2121
2391
|
* schema is copied into the directory, it has its own ARN, which is referred to applied schema
|
|
2122
2392
|
* ARN. For more information, see <a>arns</a>.</p>
|
|
@@ -2158,10 +2428,12 @@ export type RuleType = (typeof RuleType)[keyof typeof RuleType];
|
|
|
2158
2428
|
*/
|
|
2159
2429
|
export interface Rule {
|
|
2160
2430
|
/**
|
|
2431
|
+
* @public
|
|
2161
2432
|
* <p>The type of attribute validation rule.</p>
|
|
2162
2433
|
*/
|
|
2163
2434
|
Type?: RuleType | string;
|
|
2164
2435
|
/**
|
|
2436
|
+
* @public
|
|
2165
2437
|
* <p>The minimum and maximum parameters that are associated with the rule.</p>
|
|
2166
2438
|
*/
|
|
2167
2439
|
Parameters?: Record<string, string>;
|
|
@@ -2188,18 +2460,22 @@ export type FacetAttributeType = (typeof FacetAttributeType)[keyof typeof FacetA
|
|
|
2188
2460
|
*/
|
|
2189
2461
|
export interface FacetAttributeDefinition {
|
|
2190
2462
|
/**
|
|
2463
|
+
* @public
|
|
2191
2464
|
* <p>The type of the attribute.</p>
|
|
2192
2465
|
*/
|
|
2193
2466
|
Type: FacetAttributeType | string | undefined;
|
|
2194
2467
|
/**
|
|
2468
|
+
* @public
|
|
2195
2469
|
* <p>The default value of the attribute (if configured).</p>
|
|
2196
2470
|
*/
|
|
2197
2471
|
DefaultValue?: TypedAttributeValue;
|
|
2198
2472
|
/**
|
|
2473
|
+
* @public
|
|
2199
2474
|
* <p>Whether the attribute is mutable or not.</p>
|
|
2200
2475
|
*/
|
|
2201
2476
|
IsImmutable?: boolean;
|
|
2202
2477
|
/**
|
|
2478
|
+
* @public
|
|
2203
2479
|
* <p>Validation rules attached to the attribute definition.</p>
|
|
2204
2480
|
*/
|
|
2205
2481
|
Rules?: Record<string, Rule>;
|
|
@@ -2211,10 +2487,12 @@ export interface FacetAttributeDefinition {
|
|
|
2211
2487
|
*/
|
|
2212
2488
|
export interface FacetAttributeReference {
|
|
2213
2489
|
/**
|
|
2490
|
+
* @public
|
|
2214
2491
|
* <p>The target facet name that is associated with the facet reference. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>
|
|
2215
2492
|
*/
|
|
2216
2493
|
TargetFacetName: string | undefined;
|
|
2217
2494
|
/**
|
|
2495
|
+
* @public
|
|
2218
2496
|
* <p>The target attribute name that is associated with the facet reference. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>
|
|
2219
2497
|
*/
|
|
2220
2498
|
TargetAttributeName: string | undefined;
|
|
@@ -2237,19 +2515,23 @@ export type RequiredAttributeBehavior = (typeof RequiredAttributeBehavior)[keyof
|
|
|
2237
2515
|
*/
|
|
2238
2516
|
export interface FacetAttribute {
|
|
2239
2517
|
/**
|
|
2518
|
+
* @public
|
|
2240
2519
|
* <p>The name of the facet attribute.</p>
|
|
2241
2520
|
*/
|
|
2242
2521
|
Name: string | undefined;
|
|
2243
2522
|
/**
|
|
2523
|
+
* @public
|
|
2244
2524
|
* <p>A facet attribute consists of either a definition or a reference. This structure
|
|
2245
2525
|
* contains the attribute definition. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>
|
|
2246
2526
|
*/
|
|
2247
2527
|
AttributeDefinition?: FacetAttributeDefinition;
|
|
2248
2528
|
/**
|
|
2529
|
+
* @public
|
|
2249
2530
|
* <p>An attribute reference that is associated with the attribute. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>
|
|
2250
2531
|
*/
|
|
2251
2532
|
AttributeReference?: FacetAttributeReference;
|
|
2252
2533
|
/**
|
|
2534
|
+
* @public
|
|
2253
2535
|
* <p>The required behavior of the <code>FacetAttribute</code>.</p>
|
|
2254
2536
|
*/
|
|
2255
2537
|
RequiredBehavior?: RequiredAttributeBehavior | string;
|
|
@@ -2285,19 +2567,23 @@ export type ObjectType = (typeof ObjectType)[keyof typeof ObjectType];
|
|
|
2285
2567
|
*/
|
|
2286
2568
|
export interface CreateFacetRequest {
|
|
2287
2569
|
/**
|
|
2570
|
+
* @public
|
|
2288
2571
|
* <p>The schema ARN in which the new <a>Facet</a> will be created. For more
|
|
2289
2572
|
* information, see <a>arns</a>.</p>
|
|
2290
2573
|
*/
|
|
2291
2574
|
SchemaArn: string | undefined;
|
|
2292
2575
|
/**
|
|
2576
|
+
* @public
|
|
2293
2577
|
* <p>The name of the <a>Facet</a>, which is unique for a given schema.</p>
|
|
2294
2578
|
*/
|
|
2295
2579
|
Name: string | undefined;
|
|
2296
2580
|
/**
|
|
2581
|
+
* @public
|
|
2297
2582
|
* <p>The attributes that are associated with the <a>Facet</a>.</p>
|
|
2298
2583
|
*/
|
|
2299
2584
|
Attributes?: FacetAttribute[];
|
|
2300
2585
|
/**
|
|
2586
|
+
* @public
|
|
2301
2587
|
* <p>Specifies whether a given object created from this facet is of type node, leaf node,
|
|
2302
2588
|
* policy or index.</p>
|
|
2303
2589
|
* <ul>
|
|
@@ -2324,6 +2610,7 @@ export interface CreateFacetRequest {
|
|
|
2324
2610
|
*/
|
|
2325
2611
|
ObjectType?: ObjectType | string;
|
|
2326
2612
|
/**
|
|
2613
|
+
* @public
|
|
2327
2614
|
* <p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>
|
|
2328
2615
|
*/
|
|
2329
2616
|
FacetStyle?: FacetStyle | string;
|
|
@@ -2364,24 +2651,29 @@ export declare class InvalidRuleException extends __BaseException {
|
|
|
2364
2651
|
*/
|
|
2365
2652
|
export interface CreateIndexRequest {
|
|
2366
2653
|
/**
|
|
2654
|
+
* @public
|
|
2367
2655
|
* <p>The ARN of the directory where the index should be created.</p>
|
|
2368
2656
|
*/
|
|
2369
2657
|
DirectoryArn: string | undefined;
|
|
2370
2658
|
/**
|
|
2659
|
+
* @public
|
|
2371
2660
|
* <p>Specifies the attributes that should be indexed on. Currently only a single attribute
|
|
2372
2661
|
* is supported.</p>
|
|
2373
2662
|
*/
|
|
2374
2663
|
OrderedIndexedAttributeList: AttributeKey[] | undefined;
|
|
2375
2664
|
/**
|
|
2665
|
+
* @public
|
|
2376
2666
|
* <p>Indicates whether the attribute that is being indexed has unique values or
|
|
2377
2667
|
* not.</p>
|
|
2378
2668
|
*/
|
|
2379
2669
|
IsUnique: boolean | undefined;
|
|
2380
2670
|
/**
|
|
2671
|
+
* @public
|
|
2381
2672
|
* <p>A reference to the parent object that contains the index object.</p>
|
|
2382
2673
|
*/
|
|
2383
2674
|
ParentReference?: ObjectReference;
|
|
2384
2675
|
/**
|
|
2676
|
+
* @public
|
|
2385
2677
|
* <p>The name of the link between the parent object and the index object.</p>
|
|
2386
2678
|
*/
|
|
2387
2679
|
LinkName?: string;
|
|
@@ -2391,6 +2683,7 @@ export interface CreateIndexRequest {
|
|
|
2391
2683
|
*/
|
|
2392
2684
|
export interface CreateIndexResponse {
|
|
2393
2685
|
/**
|
|
2686
|
+
* @public
|
|
2394
2687
|
* <p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>
|
|
2395
2688
|
*/
|
|
2396
2689
|
ObjectIdentifier?: string;
|
|
@@ -2413,24 +2706,29 @@ export declare class UnsupportedIndexTypeException extends __BaseException {
|
|
|
2413
2706
|
*/
|
|
2414
2707
|
export interface CreateObjectRequest {
|
|
2415
2708
|
/**
|
|
2709
|
+
* @public
|
|
2416
2710
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
2417
2711
|
* in which the object will be created. For more information, see <a>arns</a>.</p>
|
|
2418
2712
|
*/
|
|
2419
2713
|
DirectoryArn: string | undefined;
|
|
2420
2714
|
/**
|
|
2715
|
+
* @public
|
|
2421
2716
|
* <p>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</p>
|
|
2422
2717
|
*/
|
|
2423
2718
|
SchemaFacets: SchemaFacet[] | undefined;
|
|
2424
2719
|
/**
|
|
2720
|
+
* @public
|
|
2425
2721
|
* <p>The attribute map whose attribute ARN contains the key and attribute value as the map
|
|
2426
2722
|
* value.</p>
|
|
2427
2723
|
*/
|
|
2428
2724
|
ObjectAttributeList?: AttributeKeyAndValue[];
|
|
2429
2725
|
/**
|
|
2726
|
+
* @public
|
|
2430
2727
|
* <p>If specified, the parent reference to which this object will be attached.</p>
|
|
2431
2728
|
*/
|
|
2432
2729
|
ParentReference?: ObjectReference;
|
|
2433
2730
|
/**
|
|
2731
|
+
* @public
|
|
2434
2732
|
* <p>The name of link that is used to attach this object to a parent.</p>
|
|
2435
2733
|
*/
|
|
2436
2734
|
LinkName?: string;
|
|
@@ -2440,6 +2738,7 @@ export interface CreateObjectRequest {
|
|
|
2440
2738
|
*/
|
|
2441
2739
|
export interface CreateObjectResponse {
|
|
2442
2740
|
/**
|
|
2741
|
+
* @public
|
|
2443
2742
|
* <p>The identifier that is associated with the object.</p>
|
|
2444
2743
|
*/
|
|
2445
2744
|
ObjectIdentifier?: string;
|
|
@@ -2449,6 +2748,7 @@ export interface CreateObjectResponse {
|
|
|
2449
2748
|
*/
|
|
2450
2749
|
export interface CreateSchemaRequest {
|
|
2451
2750
|
/**
|
|
2751
|
+
* @public
|
|
2452
2752
|
* <p>The name that is associated with the schema. This is unique to each account and in each
|
|
2453
2753
|
* region.</p>
|
|
2454
2754
|
*/
|
|
@@ -2459,6 +2759,7 @@ export interface CreateSchemaRequest {
|
|
|
2459
2759
|
*/
|
|
2460
2760
|
export interface CreateSchemaResponse {
|
|
2461
2761
|
/**
|
|
2762
|
+
* @public
|
|
2462
2763
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
2463
2764
|
* information, see <a>arns</a>.</p>
|
|
2464
2765
|
*/
|
|
@@ -2470,26 +2771,32 @@ export interface CreateSchemaResponse {
|
|
|
2470
2771
|
*/
|
|
2471
2772
|
export interface TypedLinkAttributeDefinition {
|
|
2472
2773
|
/**
|
|
2774
|
+
* @public
|
|
2473
2775
|
* <p>The unique name of the typed link attribute.</p>
|
|
2474
2776
|
*/
|
|
2475
2777
|
Name: string | undefined;
|
|
2476
2778
|
/**
|
|
2779
|
+
* @public
|
|
2477
2780
|
* <p>The type of the attribute.</p>
|
|
2478
2781
|
*/
|
|
2479
2782
|
Type: FacetAttributeType | string | undefined;
|
|
2480
2783
|
/**
|
|
2784
|
+
* @public
|
|
2481
2785
|
* <p>The default value of the attribute (if configured).</p>
|
|
2482
2786
|
*/
|
|
2483
2787
|
DefaultValue?: TypedAttributeValue;
|
|
2484
2788
|
/**
|
|
2789
|
+
* @public
|
|
2485
2790
|
* <p>Whether the attribute is mutable or not.</p>
|
|
2486
2791
|
*/
|
|
2487
2792
|
IsImmutable?: boolean;
|
|
2488
2793
|
/**
|
|
2794
|
+
* @public
|
|
2489
2795
|
* <p>Validation rules that are attached to the attribute definition.</p>
|
|
2490
2796
|
*/
|
|
2491
2797
|
Rules?: Record<string, Rule>;
|
|
2492
2798
|
/**
|
|
2799
|
+
* @public
|
|
2493
2800
|
* <p>The required behavior of the <code>TypedLinkAttributeDefinition</code>.</p>
|
|
2494
2801
|
*/
|
|
2495
2802
|
RequiredBehavior: RequiredAttributeBehavior | string | undefined;
|
|
@@ -2501,14 +2808,17 @@ export interface TypedLinkAttributeDefinition {
|
|
|
2501
2808
|
*/
|
|
2502
2809
|
export interface TypedLinkFacet {
|
|
2503
2810
|
/**
|
|
2811
|
+
* @public
|
|
2504
2812
|
* <p>The unique name of the typed link facet.</p>
|
|
2505
2813
|
*/
|
|
2506
2814
|
Name: string | undefined;
|
|
2507
2815
|
/**
|
|
2816
|
+
* @public
|
|
2508
2817
|
* <p>A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.</p>
|
|
2509
2818
|
*/
|
|
2510
2819
|
Attributes: TypedLinkAttributeDefinition[] | undefined;
|
|
2511
2820
|
/**
|
|
2821
|
+
* @public
|
|
2512
2822
|
* <p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>
|
|
2513
2823
|
*/
|
|
2514
2824
|
IdentityAttributeOrder: string[] | undefined;
|
|
@@ -2518,11 +2828,13 @@ export interface TypedLinkFacet {
|
|
|
2518
2828
|
*/
|
|
2519
2829
|
export interface CreateTypedLinkFacetRequest {
|
|
2520
2830
|
/**
|
|
2831
|
+
* @public
|
|
2521
2832
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
2522
2833
|
* information, see <a>arns</a>.</p>
|
|
2523
2834
|
*/
|
|
2524
2835
|
SchemaArn: string | undefined;
|
|
2525
2836
|
/**
|
|
2837
|
+
* @public
|
|
2526
2838
|
* <p>
|
|
2527
2839
|
* <a>Facet</a> structure that is associated with the typed link
|
|
2528
2840
|
* facet.</p>
|
|
@@ -2539,6 +2851,7 @@ export interface CreateTypedLinkFacetResponse {
|
|
|
2539
2851
|
*/
|
|
2540
2852
|
export interface DeleteDirectoryRequest {
|
|
2541
2853
|
/**
|
|
2854
|
+
* @public
|
|
2542
2855
|
* <p>The ARN of the directory to delete.</p>
|
|
2543
2856
|
*/
|
|
2544
2857
|
DirectoryArn: string | undefined;
|
|
@@ -2548,6 +2861,7 @@ export interface DeleteDirectoryRequest {
|
|
|
2548
2861
|
*/
|
|
2549
2862
|
export interface DeleteDirectoryResponse {
|
|
2550
2863
|
/**
|
|
2864
|
+
* @public
|
|
2551
2865
|
* <p>The ARN of the deleted directory.</p>
|
|
2552
2866
|
*/
|
|
2553
2867
|
DirectoryArn: string | undefined;
|
|
@@ -2584,11 +2898,13 @@ export declare class DirectoryNotDisabledException extends __BaseException {
|
|
|
2584
2898
|
*/
|
|
2585
2899
|
export interface DeleteFacetRequest {
|
|
2586
2900
|
/**
|
|
2901
|
+
* @public
|
|
2587
2902
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>.
|
|
2588
2903
|
* For more information, see <a>arns</a>.</p>
|
|
2589
2904
|
*/
|
|
2590
2905
|
SchemaArn: string | undefined;
|
|
2591
2906
|
/**
|
|
2907
|
+
* @public
|
|
2592
2908
|
* <p>The name of the facet to delete.</p>
|
|
2593
2909
|
*/
|
|
2594
2910
|
Name: string | undefined;
|
|
@@ -2630,11 +2946,13 @@ export declare class FacetNotFoundException extends __BaseException {
|
|
|
2630
2946
|
*/
|
|
2631
2947
|
export interface DeleteObjectRequest {
|
|
2632
2948
|
/**
|
|
2949
|
+
* @public
|
|
2633
2950
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
2634
2951
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
2635
2952
|
*/
|
|
2636
2953
|
DirectoryArn: string | undefined;
|
|
2637
2954
|
/**
|
|
2955
|
+
* @public
|
|
2638
2956
|
* <p>A reference that identifies the object.</p>
|
|
2639
2957
|
*/
|
|
2640
2958
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -2663,6 +2981,7 @@ export declare class ObjectNotDetachedException extends __BaseException {
|
|
|
2663
2981
|
*/
|
|
2664
2982
|
export interface DeleteSchemaRequest {
|
|
2665
2983
|
/**
|
|
2984
|
+
* @public
|
|
2666
2985
|
* <p>The Amazon Resource Name (ARN) of the development schema. For more information, see
|
|
2667
2986
|
* <a>arns</a>.</p>
|
|
2668
2987
|
*/
|
|
@@ -2673,6 +2992,7 @@ export interface DeleteSchemaRequest {
|
|
|
2673
2992
|
*/
|
|
2674
2993
|
export interface DeleteSchemaResponse {
|
|
2675
2994
|
/**
|
|
2995
|
+
* @public
|
|
2676
2996
|
* <p>The input ARN that is returned as part of the response. For more information, see
|
|
2677
2997
|
* <a>arns</a>.</p>
|
|
2678
2998
|
*/
|
|
@@ -2697,11 +3017,13 @@ export declare class StillContainsLinksException extends __BaseException {
|
|
|
2697
3017
|
*/
|
|
2698
3018
|
export interface DeleteTypedLinkFacetRequest {
|
|
2699
3019
|
/**
|
|
3020
|
+
* @public
|
|
2700
3021
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
2701
3022
|
* information, see <a>arns</a>.</p>
|
|
2702
3023
|
*/
|
|
2703
3024
|
SchemaArn: string | undefined;
|
|
2704
3025
|
/**
|
|
3026
|
+
* @public
|
|
2705
3027
|
* <p>The unique name of the typed link facet.</p>
|
|
2706
3028
|
*/
|
|
2707
3029
|
Name: string | undefined;
|
|
@@ -2716,15 +3038,18 @@ export interface DeleteTypedLinkFacetResponse {
|
|
|
2716
3038
|
*/
|
|
2717
3039
|
export interface DetachFromIndexRequest {
|
|
2718
3040
|
/**
|
|
3041
|
+
* @public
|
|
2719
3042
|
* <p>The Amazon Resource Name (ARN) of the directory the index and object exist
|
|
2720
3043
|
* in.</p>
|
|
2721
3044
|
*/
|
|
2722
3045
|
DirectoryArn: string | undefined;
|
|
2723
3046
|
/**
|
|
3047
|
+
* @public
|
|
2724
3048
|
* <p>A reference to the index object.</p>
|
|
2725
3049
|
*/
|
|
2726
3050
|
IndexReference: ObjectReference | undefined;
|
|
2727
3051
|
/**
|
|
3052
|
+
* @public
|
|
2728
3053
|
* <p>A reference to the object being detached from the index.</p>
|
|
2729
3054
|
*/
|
|
2730
3055
|
TargetReference: ObjectReference | undefined;
|
|
@@ -2734,6 +3059,7 @@ export interface DetachFromIndexRequest {
|
|
|
2734
3059
|
*/
|
|
2735
3060
|
export interface DetachFromIndexResponse {
|
|
2736
3061
|
/**
|
|
3062
|
+
* @public
|
|
2737
3063
|
* <p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>
|
|
2738
3064
|
*/
|
|
2739
3065
|
DetachedObjectIdentifier?: string;
|
|
@@ -2756,16 +3082,19 @@ export declare class ObjectAlreadyDetachedException extends __BaseException {
|
|
|
2756
3082
|
*/
|
|
2757
3083
|
export interface DetachObjectRequest {
|
|
2758
3084
|
/**
|
|
3085
|
+
* @public
|
|
2759
3086
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
2760
3087
|
* where objects reside. For more information, see <a>arns</a>.</p>
|
|
2761
3088
|
*/
|
|
2762
3089
|
DirectoryArn: string | undefined;
|
|
2763
3090
|
/**
|
|
3091
|
+
* @public
|
|
2764
3092
|
* <p>The parent reference from which the object with the specified link name is
|
|
2765
3093
|
* detached.</p>
|
|
2766
3094
|
*/
|
|
2767
3095
|
ParentReference: ObjectReference | undefined;
|
|
2768
3096
|
/**
|
|
3097
|
+
* @public
|
|
2769
3098
|
* <p>The link name associated with the object that needs to be detached.</p>
|
|
2770
3099
|
*/
|
|
2771
3100
|
LinkName: string | undefined;
|
|
@@ -2775,6 +3104,7 @@ export interface DetachObjectRequest {
|
|
|
2775
3104
|
*/
|
|
2776
3105
|
export interface DetachObjectResponse {
|
|
2777
3106
|
/**
|
|
3107
|
+
* @public
|
|
2778
3108
|
* <p>The <code>ObjectIdentifier</code> that was detached from the object.</p>
|
|
2779
3109
|
*/
|
|
2780
3110
|
DetachedObjectIdentifier?: string;
|
|
@@ -2798,15 +3128,18 @@ export declare class NotNodeException extends __BaseException {
|
|
|
2798
3128
|
*/
|
|
2799
3129
|
export interface DetachPolicyRequest {
|
|
2800
3130
|
/**
|
|
3131
|
+
* @public
|
|
2801
3132
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
2802
3133
|
* where both objects reside. For more information, see <a>arns</a>.</p>
|
|
2803
3134
|
*/
|
|
2804
3135
|
DirectoryArn: string | undefined;
|
|
2805
3136
|
/**
|
|
3137
|
+
* @public
|
|
2806
3138
|
* <p>Reference that identifies the policy object.</p>
|
|
2807
3139
|
*/
|
|
2808
3140
|
PolicyReference: ObjectReference | undefined;
|
|
2809
3141
|
/**
|
|
3142
|
+
* @public
|
|
2810
3143
|
* <p>Reference that identifies the object whose policy object will be detached.</p>
|
|
2811
3144
|
*/
|
|
2812
3145
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -2821,11 +3154,13 @@ export interface DetachPolicyResponse {
|
|
|
2821
3154
|
*/
|
|
2822
3155
|
export interface DetachTypedLinkRequest {
|
|
2823
3156
|
/**
|
|
3157
|
+
* @public
|
|
2824
3158
|
* <p>The Amazon Resource Name (ARN) of the directory where you want to detach the typed
|
|
2825
3159
|
* link.</p>
|
|
2826
3160
|
*/
|
|
2827
3161
|
DirectoryArn: string | undefined;
|
|
2828
3162
|
/**
|
|
3163
|
+
* @public
|
|
2829
3164
|
* <p>Used to accept a typed link specifier as input.</p>
|
|
2830
3165
|
*/
|
|
2831
3166
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
@@ -2835,6 +3170,7 @@ export interface DetachTypedLinkRequest {
|
|
|
2835
3170
|
*/
|
|
2836
3171
|
export interface DisableDirectoryRequest {
|
|
2837
3172
|
/**
|
|
3173
|
+
* @public
|
|
2838
3174
|
* <p>The ARN of the directory to disable.</p>
|
|
2839
3175
|
*/
|
|
2840
3176
|
DirectoryArn: string | undefined;
|
|
@@ -2844,6 +3180,7 @@ export interface DisableDirectoryRequest {
|
|
|
2844
3180
|
*/
|
|
2845
3181
|
export interface DisableDirectoryResponse {
|
|
2846
3182
|
/**
|
|
3183
|
+
* @public
|
|
2847
3184
|
* <p>The ARN of the directory that has been disabled.</p>
|
|
2848
3185
|
*/
|
|
2849
3186
|
DirectoryArn: string | undefined;
|
|
@@ -2853,6 +3190,7 @@ export interface DisableDirectoryResponse {
|
|
|
2853
3190
|
*/
|
|
2854
3191
|
export interface EnableDirectoryRequest {
|
|
2855
3192
|
/**
|
|
3193
|
+
* @public
|
|
2856
3194
|
* <p>The ARN of the directory to enable.</p>
|
|
2857
3195
|
*/
|
|
2858
3196
|
DirectoryArn: string | undefined;
|
|
@@ -2862,6 +3200,7 @@ export interface EnableDirectoryRequest {
|
|
|
2862
3200
|
*/
|
|
2863
3201
|
export interface EnableDirectoryResponse {
|
|
2864
3202
|
/**
|
|
3203
|
+
* @public
|
|
2865
3204
|
* <p>The ARN of the enabled directory.</p>
|
|
2866
3205
|
*/
|
|
2867
3206
|
DirectoryArn: string | undefined;
|
|
@@ -2871,6 +3210,7 @@ export interface EnableDirectoryResponse {
|
|
|
2871
3210
|
*/
|
|
2872
3211
|
export interface GetAppliedSchemaVersionRequest {
|
|
2873
3212
|
/**
|
|
3213
|
+
* @public
|
|
2874
3214
|
* <p>The ARN of the applied schema.</p>
|
|
2875
3215
|
*/
|
|
2876
3216
|
SchemaArn: string | undefined;
|
|
@@ -2880,6 +3220,7 @@ export interface GetAppliedSchemaVersionRequest {
|
|
|
2880
3220
|
*/
|
|
2881
3221
|
export interface GetAppliedSchemaVersionResponse {
|
|
2882
3222
|
/**
|
|
3223
|
+
* @public
|
|
2883
3224
|
* <p>Current applied schema ARN, including the minor version in use if one was provided.</p>
|
|
2884
3225
|
*/
|
|
2885
3226
|
AppliedSchemaArn?: string;
|
|
@@ -2889,6 +3230,7 @@ export interface GetAppliedSchemaVersionResponse {
|
|
|
2889
3230
|
*/
|
|
2890
3231
|
export interface GetDirectoryRequest {
|
|
2891
3232
|
/**
|
|
3233
|
+
* @public
|
|
2892
3234
|
* <p>The ARN of the directory.</p>
|
|
2893
3235
|
*/
|
|
2894
3236
|
DirectoryArn: string | undefined;
|
|
@@ -2912,19 +3254,23 @@ export type DirectoryState = (typeof DirectoryState)[keyof typeof DirectoryState
|
|
|
2912
3254
|
*/
|
|
2913
3255
|
export interface Directory {
|
|
2914
3256
|
/**
|
|
3257
|
+
* @public
|
|
2915
3258
|
* <p>The name of the directory.</p>
|
|
2916
3259
|
*/
|
|
2917
3260
|
Name?: string;
|
|
2918
3261
|
/**
|
|
3262
|
+
* @public
|
|
2919
3263
|
* <p>The Amazon Resource Name (ARN) that is associated with the directory. For more
|
|
2920
3264
|
* information, see <a>arns</a>.</p>
|
|
2921
3265
|
*/
|
|
2922
3266
|
DirectoryArn?: string;
|
|
2923
3267
|
/**
|
|
3268
|
+
* @public
|
|
2924
3269
|
* <p>The state of the directory. Can be either <code>Enabled</code>, <code>Disabled</code>, or <code>Deleted</code>.</p>
|
|
2925
3270
|
*/
|
|
2926
3271
|
State?: DirectoryState | string;
|
|
2927
3272
|
/**
|
|
3273
|
+
* @public
|
|
2928
3274
|
* <p>The date and time when the directory was created.</p>
|
|
2929
3275
|
*/
|
|
2930
3276
|
CreationDateTime?: Date;
|
|
@@ -2934,6 +3280,7 @@ export interface Directory {
|
|
|
2934
3280
|
*/
|
|
2935
3281
|
export interface GetDirectoryResponse {
|
|
2936
3282
|
/**
|
|
3283
|
+
* @public
|
|
2937
3284
|
* <p>Metadata about the directory.</p>
|
|
2938
3285
|
*/
|
|
2939
3286
|
Directory: Directory | undefined;
|
|
@@ -2943,11 +3290,13 @@ export interface GetDirectoryResponse {
|
|
|
2943
3290
|
*/
|
|
2944
3291
|
export interface GetFacetRequest {
|
|
2945
3292
|
/**
|
|
3293
|
+
* @public
|
|
2946
3294
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>.
|
|
2947
3295
|
* For more information, see <a>arns</a>.</p>
|
|
2948
3296
|
*/
|
|
2949
3297
|
SchemaArn: string | undefined;
|
|
2950
3298
|
/**
|
|
3299
|
+
* @public
|
|
2951
3300
|
* <p>The name of the facet to retrieve.</p>
|
|
2952
3301
|
*/
|
|
2953
3302
|
Name: string | undefined;
|
|
@@ -2960,14 +3309,17 @@ export interface GetFacetRequest {
|
|
|
2960
3309
|
*/
|
|
2961
3310
|
export interface Facet {
|
|
2962
3311
|
/**
|
|
3312
|
+
* @public
|
|
2963
3313
|
* <p>The name of the <a>Facet</a>.</p>
|
|
2964
3314
|
*/
|
|
2965
3315
|
Name?: string;
|
|
2966
3316
|
/**
|
|
3317
|
+
* @public
|
|
2967
3318
|
* <p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>
|
|
2968
3319
|
*/
|
|
2969
3320
|
ObjectType?: ObjectType | string;
|
|
2970
3321
|
/**
|
|
3322
|
+
* @public
|
|
2971
3323
|
* <p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>
|
|
2972
3324
|
*/
|
|
2973
3325
|
FacetStyle?: FacetStyle | string;
|
|
@@ -2977,6 +3329,7 @@ export interface Facet {
|
|
|
2977
3329
|
*/
|
|
2978
3330
|
export interface GetFacetResponse {
|
|
2979
3331
|
/**
|
|
3332
|
+
* @public
|
|
2980
3333
|
* <p>The <a>Facet</a> structure that is associated with the facet.</p>
|
|
2981
3334
|
*/
|
|
2982
3335
|
Facet?: Facet;
|
|
@@ -2986,18 +3339,22 @@ export interface GetFacetResponse {
|
|
|
2986
3339
|
*/
|
|
2987
3340
|
export interface GetLinkAttributesRequest {
|
|
2988
3341
|
/**
|
|
3342
|
+
* @public
|
|
2989
3343
|
* <p>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
2990
3344
|
*/
|
|
2991
3345
|
DirectoryArn: string | undefined;
|
|
2992
3346
|
/**
|
|
3347
|
+
* @public
|
|
2993
3348
|
* <p>Allows a typed link specifier to be accepted as input.</p>
|
|
2994
3349
|
*/
|
|
2995
3350
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
2996
3351
|
/**
|
|
3352
|
+
* @public
|
|
2997
3353
|
* <p>A list of attribute names whose values will be retrieved.</p>
|
|
2998
3354
|
*/
|
|
2999
3355
|
AttributeNames: string[] | undefined;
|
|
3000
3356
|
/**
|
|
3357
|
+
* @public
|
|
3001
3358
|
* <p>The consistency level at which to retrieve the attributes on a typed link.</p>
|
|
3002
3359
|
*/
|
|
3003
3360
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3007,6 +3364,7 @@ export interface GetLinkAttributesRequest {
|
|
|
3007
3364
|
*/
|
|
3008
3365
|
export interface GetLinkAttributesResponse {
|
|
3009
3366
|
/**
|
|
3367
|
+
* @public
|
|
3010
3368
|
* <p>The attributes that are associated with the typed link.</p>
|
|
3011
3369
|
*/
|
|
3012
3370
|
Attributes?: AttributeKeyAndValue[];
|
|
@@ -3016,22 +3374,27 @@ export interface GetLinkAttributesResponse {
|
|
|
3016
3374
|
*/
|
|
3017
3375
|
export interface GetObjectAttributesRequest {
|
|
3018
3376
|
/**
|
|
3377
|
+
* @public
|
|
3019
3378
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</p>
|
|
3020
3379
|
*/
|
|
3021
3380
|
DirectoryArn: string | undefined;
|
|
3022
3381
|
/**
|
|
3382
|
+
* @public
|
|
3023
3383
|
* <p>Reference that identifies the object whose attributes will be retrieved.</p>
|
|
3024
3384
|
*/
|
|
3025
3385
|
ObjectReference: ObjectReference | undefined;
|
|
3026
3386
|
/**
|
|
3387
|
+
* @public
|
|
3027
3388
|
* <p>The consistency level at which to retrieve the attributes on an object.</p>
|
|
3028
3389
|
*/
|
|
3029
3390
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
3030
3391
|
/**
|
|
3392
|
+
* @public
|
|
3031
3393
|
* <p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>
|
|
3032
3394
|
*/
|
|
3033
3395
|
SchemaFacet: SchemaFacet | undefined;
|
|
3034
3396
|
/**
|
|
3397
|
+
* @public
|
|
3035
3398
|
* <p>List of attribute names whose values will be retrieved.</p>
|
|
3036
3399
|
*/
|
|
3037
3400
|
AttributeNames: string[] | undefined;
|
|
@@ -3041,6 +3404,7 @@ export interface GetObjectAttributesRequest {
|
|
|
3041
3404
|
*/
|
|
3042
3405
|
export interface GetObjectAttributesResponse {
|
|
3043
3406
|
/**
|
|
3407
|
+
* @public
|
|
3044
3408
|
* <p>The attributes that are associated with the object.</p>
|
|
3045
3409
|
*/
|
|
3046
3410
|
Attributes?: AttributeKeyAndValue[];
|
|
@@ -3050,14 +3414,17 @@ export interface GetObjectAttributesResponse {
|
|
|
3050
3414
|
*/
|
|
3051
3415
|
export interface GetObjectInformationRequest {
|
|
3052
3416
|
/**
|
|
3417
|
+
* @public
|
|
3053
3418
|
* <p>The ARN of the directory being retrieved.</p>
|
|
3054
3419
|
*/
|
|
3055
3420
|
DirectoryArn: string | undefined;
|
|
3056
3421
|
/**
|
|
3422
|
+
* @public
|
|
3057
3423
|
* <p>A reference to the object.</p>
|
|
3058
3424
|
*/
|
|
3059
3425
|
ObjectReference: ObjectReference | undefined;
|
|
3060
3426
|
/**
|
|
3427
|
+
* @public
|
|
3061
3428
|
* <p>The consistency level at which to retrieve the object information.</p>
|
|
3062
3429
|
*/
|
|
3063
3430
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3067,10 +3434,12 @@ export interface GetObjectInformationRequest {
|
|
|
3067
3434
|
*/
|
|
3068
3435
|
export interface GetObjectInformationResponse {
|
|
3069
3436
|
/**
|
|
3437
|
+
* @public
|
|
3070
3438
|
* <p>The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See <a>GetAppliedSchemaVersion</a> for details.</p>
|
|
3071
3439
|
*/
|
|
3072
3440
|
SchemaFacets?: SchemaFacet[];
|
|
3073
3441
|
/**
|
|
3442
|
+
* @public
|
|
3074
3443
|
* <p>The <code>ObjectIdentifier</code> of the specified object.</p>
|
|
3075
3444
|
*/
|
|
3076
3445
|
ObjectIdentifier?: string;
|
|
@@ -3080,6 +3449,7 @@ export interface GetObjectInformationResponse {
|
|
|
3080
3449
|
*/
|
|
3081
3450
|
export interface GetSchemaAsJsonRequest {
|
|
3082
3451
|
/**
|
|
3452
|
+
* @public
|
|
3083
3453
|
* <p>The ARN of the schema to retrieve.</p>
|
|
3084
3454
|
*/
|
|
3085
3455
|
SchemaArn: string | undefined;
|
|
@@ -3089,10 +3459,12 @@ export interface GetSchemaAsJsonRequest {
|
|
|
3089
3459
|
*/
|
|
3090
3460
|
export interface GetSchemaAsJsonResponse {
|
|
3091
3461
|
/**
|
|
3462
|
+
* @public
|
|
3092
3463
|
* <p>The name of the retrieved schema.</p>
|
|
3093
3464
|
*/
|
|
3094
3465
|
Name?: string;
|
|
3095
3466
|
/**
|
|
3467
|
+
* @public
|
|
3096
3468
|
* <p>The JSON representation of the schema document.</p>
|
|
3097
3469
|
*/
|
|
3098
3470
|
Document?: string;
|
|
@@ -3102,11 +3474,13 @@ export interface GetSchemaAsJsonResponse {
|
|
|
3102
3474
|
*/
|
|
3103
3475
|
export interface GetTypedLinkFacetInformationRequest {
|
|
3104
3476
|
/**
|
|
3477
|
+
* @public
|
|
3105
3478
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
3106
3479
|
* information, see <a>arns</a>.</p>
|
|
3107
3480
|
*/
|
|
3108
3481
|
SchemaArn: string | undefined;
|
|
3109
3482
|
/**
|
|
3483
|
+
* @public
|
|
3110
3484
|
* <p>The unique name of the typed link facet.</p>
|
|
3111
3485
|
*/
|
|
3112
3486
|
Name: string | undefined;
|
|
@@ -3116,6 +3490,7 @@ export interface GetTypedLinkFacetInformationRequest {
|
|
|
3116
3490
|
*/
|
|
3117
3491
|
export interface GetTypedLinkFacetInformationResponse {
|
|
3118
3492
|
/**
|
|
3493
|
+
* @public
|
|
3119
3494
|
* <p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed
|
|
3120
3495
|
* links considers the order that the attributes are defined on the typed link facet. When
|
|
3121
3496
|
* providing ranges to typed link selection, any inexact ranges must be specified at the end. Any
|
|
@@ -3143,18 +3518,22 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
3143
3518
|
*/
|
|
3144
3519
|
export interface ListAppliedSchemaArnsRequest {
|
|
3145
3520
|
/**
|
|
3521
|
+
* @public
|
|
3146
3522
|
* <p>The ARN of the directory you are listing.</p>
|
|
3147
3523
|
*/
|
|
3148
3524
|
DirectoryArn: string | undefined;
|
|
3149
3525
|
/**
|
|
3526
|
+
* @public
|
|
3150
3527
|
* <p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>
|
|
3151
3528
|
*/
|
|
3152
3529
|
SchemaArn?: string;
|
|
3153
3530
|
/**
|
|
3531
|
+
* @public
|
|
3154
3532
|
* <p>The pagination token.</p>
|
|
3155
3533
|
*/
|
|
3156
3534
|
NextToken?: string;
|
|
3157
3535
|
/**
|
|
3536
|
+
* @public
|
|
3158
3537
|
* <p>The maximum number of results to retrieve.</p>
|
|
3159
3538
|
*/
|
|
3160
3539
|
MaxResults?: number;
|
|
@@ -3164,10 +3543,12 @@ export interface ListAppliedSchemaArnsRequest {
|
|
|
3164
3543
|
*/
|
|
3165
3544
|
export interface ListAppliedSchemaArnsResponse {
|
|
3166
3545
|
/**
|
|
3546
|
+
* @public
|
|
3167
3547
|
* <p>The ARNs of schemas that are applied to the directory.</p>
|
|
3168
3548
|
*/
|
|
3169
3549
|
SchemaArns?: string[];
|
|
3170
3550
|
/**
|
|
3551
|
+
* @public
|
|
3171
3552
|
* <p>The pagination token.</p>
|
|
3172
3553
|
*/
|
|
3173
3554
|
NextToken?: string;
|
|
@@ -3177,22 +3558,27 @@ export interface ListAppliedSchemaArnsResponse {
|
|
|
3177
3558
|
*/
|
|
3178
3559
|
export interface ListAttachedIndicesRequest {
|
|
3179
3560
|
/**
|
|
3561
|
+
* @public
|
|
3180
3562
|
* <p>The ARN of the directory.</p>
|
|
3181
3563
|
*/
|
|
3182
3564
|
DirectoryArn: string | undefined;
|
|
3183
3565
|
/**
|
|
3566
|
+
* @public
|
|
3184
3567
|
* <p>A reference to the object that has indices attached.</p>
|
|
3185
3568
|
*/
|
|
3186
3569
|
TargetReference: ObjectReference | undefined;
|
|
3187
3570
|
/**
|
|
3571
|
+
* @public
|
|
3188
3572
|
* <p>The pagination token.</p>
|
|
3189
3573
|
*/
|
|
3190
3574
|
NextToken?: string;
|
|
3191
3575
|
/**
|
|
3576
|
+
* @public
|
|
3192
3577
|
* <p>The maximum number of results to retrieve.</p>
|
|
3193
3578
|
*/
|
|
3194
3579
|
MaxResults?: number;
|
|
3195
3580
|
/**
|
|
3581
|
+
* @public
|
|
3196
3582
|
* <p>The consistency level to use for this operation.</p>
|
|
3197
3583
|
*/
|
|
3198
3584
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3202,10 +3588,12 @@ export interface ListAttachedIndicesRequest {
|
|
|
3202
3588
|
*/
|
|
3203
3589
|
export interface ListAttachedIndicesResponse {
|
|
3204
3590
|
/**
|
|
3591
|
+
* @public
|
|
3205
3592
|
* <p>The indices attached to the specified object.</p>
|
|
3206
3593
|
*/
|
|
3207
3594
|
IndexAttachments?: IndexAttachment[];
|
|
3208
3595
|
/**
|
|
3596
|
+
* @public
|
|
3209
3597
|
* <p>The pagination token.</p>
|
|
3210
3598
|
*/
|
|
3211
3599
|
NextToken?: string;
|
|
@@ -3215,10 +3603,12 @@ export interface ListAttachedIndicesResponse {
|
|
|
3215
3603
|
*/
|
|
3216
3604
|
export interface ListDevelopmentSchemaArnsRequest {
|
|
3217
3605
|
/**
|
|
3606
|
+
* @public
|
|
3218
3607
|
* <p>The pagination token.</p>
|
|
3219
3608
|
*/
|
|
3220
3609
|
NextToken?: string;
|
|
3221
3610
|
/**
|
|
3611
|
+
* @public
|
|
3222
3612
|
* <p>The maximum number of results to retrieve.</p>
|
|
3223
3613
|
*/
|
|
3224
3614
|
MaxResults?: number;
|
|
@@ -3228,10 +3618,12 @@ export interface ListDevelopmentSchemaArnsRequest {
|
|
|
3228
3618
|
*/
|
|
3229
3619
|
export interface ListDevelopmentSchemaArnsResponse {
|
|
3230
3620
|
/**
|
|
3621
|
+
* @public
|
|
3231
3622
|
* <p>The ARNs of retrieved development schemas.</p>
|
|
3232
3623
|
*/
|
|
3233
3624
|
SchemaArns?: string[];
|
|
3234
3625
|
/**
|
|
3626
|
+
* @public
|
|
3235
3627
|
* <p>The pagination token.</p>
|
|
3236
3628
|
*/
|
|
3237
3629
|
NextToken?: string;
|
|
@@ -3241,14 +3633,17 @@ export interface ListDevelopmentSchemaArnsResponse {
|
|
|
3241
3633
|
*/
|
|
3242
3634
|
export interface ListDirectoriesRequest {
|
|
3243
3635
|
/**
|
|
3636
|
+
* @public
|
|
3244
3637
|
* <p>The pagination token.</p>
|
|
3245
3638
|
*/
|
|
3246
3639
|
NextToken?: string;
|
|
3247
3640
|
/**
|
|
3641
|
+
* @public
|
|
3248
3642
|
* <p>The maximum number of results to retrieve.</p>
|
|
3249
3643
|
*/
|
|
3250
3644
|
MaxResults?: number;
|
|
3251
3645
|
/**
|
|
3646
|
+
* @public
|
|
3252
3647
|
* <p>The state of the directories in the list. Can be either Enabled, Disabled, or
|
|
3253
3648
|
* Deleted.</p>
|
|
3254
3649
|
*/
|
|
@@ -3259,11 +3654,13 @@ export interface ListDirectoriesRequest {
|
|
|
3259
3654
|
*/
|
|
3260
3655
|
export interface ListDirectoriesResponse {
|
|
3261
3656
|
/**
|
|
3657
|
+
* @public
|
|
3262
3658
|
* <p>Lists all directories that are associated with your account in pagination
|
|
3263
3659
|
* fashion.</p>
|
|
3264
3660
|
*/
|
|
3265
3661
|
Directories: Directory[] | undefined;
|
|
3266
3662
|
/**
|
|
3663
|
+
* @public
|
|
3267
3664
|
* <p>The pagination token.</p>
|
|
3268
3665
|
*/
|
|
3269
3666
|
NextToken?: string;
|
|
@@ -3273,18 +3670,22 @@ export interface ListDirectoriesResponse {
|
|
|
3273
3670
|
*/
|
|
3274
3671
|
export interface ListFacetAttributesRequest {
|
|
3275
3672
|
/**
|
|
3673
|
+
* @public
|
|
3276
3674
|
* <p>The ARN of the schema where the facet resides.</p>
|
|
3277
3675
|
*/
|
|
3278
3676
|
SchemaArn: string | undefined;
|
|
3279
3677
|
/**
|
|
3678
|
+
* @public
|
|
3280
3679
|
* <p>The name of the facet whose attributes will be retrieved.</p>
|
|
3281
3680
|
*/
|
|
3282
3681
|
Name: string | undefined;
|
|
3283
3682
|
/**
|
|
3683
|
+
* @public
|
|
3284
3684
|
* <p>The pagination token.</p>
|
|
3285
3685
|
*/
|
|
3286
3686
|
NextToken?: string;
|
|
3287
3687
|
/**
|
|
3688
|
+
* @public
|
|
3288
3689
|
* <p>The maximum number of results to retrieve.</p>
|
|
3289
3690
|
*/
|
|
3290
3691
|
MaxResults?: number;
|
|
@@ -3294,10 +3695,12 @@ export interface ListFacetAttributesRequest {
|
|
|
3294
3695
|
*/
|
|
3295
3696
|
export interface ListFacetAttributesResponse {
|
|
3296
3697
|
/**
|
|
3698
|
+
* @public
|
|
3297
3699
|
* <p>The attributes attached to the facet.</p>
|
|
3298
3700
|
*/
|
|
3299
3701
|
Attributes?: FacetAttribute[];
|
|
3300
3702
|
/**
|
|
3703
|
+
* @public
|
|
3301
3704
|
* <p>The pagination token.</p>
|
|
3302
3705
|
*/
|
|
3303
3706
|
NextToken?: string;
|
|
@@ -3307,14 +3710,17 @@ export interface ListFacetAttributesResponse {
|
|
|
3307
3710
|
*/
|
|
3308
3711
|
export interface ListFacetNamesRequest {
|
|
3309
3712
|
/**
|
|
3713
|
+
* @public
|
|
3310
3714
|
* <p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>
|
|
3311
3715
|
*/
|
|
3312
3716
|
SchemaArn: string | undefined;
|
|
3313
3717
|
/**
|
|
3718
|
+
* @public
|
|
3314
3719
|
* <p>The pagination token.</p>
|
|
3315
3720
|
*/
|
|
3316
3721
|
NextToken?: string;
|
|
3317
3722
|
/**
|
|
3723
|
+
* @public
|
|
3318
3724
|
* <p>The maximum number of results to retrieve.</p>
|
|
3319
3725
|
*/
|
|
3320
3726
|
MaxResults?: number;
|
|
@@ -3324,10 +3730,12 @@ export interface ListFacetNamesRequest {
|
|
|
3324
3730
|
*/
|
|
3325
3731
|
export interface ListFacetNamesResponse {
|
|
3326
3732
|
/**
|
|
3733
|
+
* @public
|
|
3327
3734
|
* <p>The names of facets that exist within the schema.</p>
|
|
3328
3735
|
*/
|
|
3329
3736
|
FacetNames?: string[];
|
|
3330
3737
|
/**
|
|
3738
|
+
* @public
|
|
3331
3739
|
* <p>The pagination token.</p>
|
|
3332
3740
|
*/
|
|
3333
3741
|
NextToken?: string;
|
|
@@ -3337,34 +3745,41 @@ export interface ListFacetNamesResponse {
|
|
|
3337
3745
|
*/
|
|
3338
3746
|
export interface ListIncomingTypedLinksRequest {
|
|
3339
3747
|
/**
|
|
3748
|
+
* @public
|
|
3340
3749
|
* <p>The Amazon Resource Name (ARN) of the directory where you want to list the typed
|
|
3341
3750
|
* links.</p>
|
|
3342
3751
|
*/
|
|
3343
3752
|
DirectoryArn: string | undefined;
|
|
3344
3753
|
/**
|
|
3754
|
+
* @public
|
|
3345
3755
|
* <p>Reference that identifies the object whose attributes will be listed.</p>
|
|
3346
3756
|
*/
|
|
3347
3757
|
ObjectReference: ObjectReference | undefined;
|
|
3348
3758
|
/**
|
|
3759
|
+
* @public
|
|
3349
3760
|
* <p>Provides range filters for multiple attributes. When providing ranges to typed link
|
|
3350
3761
|
* selection, any inexact ranges must be specified at the end. Any attributes that do not have a
|
|
3351
3762
|
* range specified are presumed to match the entire range.</p>
|
|
3352
3763
|
*/
|
|
3353
3764
|
FilterAttributeRanges?: TypedLinkAttributeRange[];
|
|
3354
3765
|
/**
|
|
3766
|
+
* @public
|
|
3355
3767
|
* <p>Filters are interpreted in the order of the attributes on the typed link facet, not the
|
|
3356
3768
|
* order in which they are supplied to any API calls.</p>
|
|
3357
3769
|
*/
|
|
3358
3770
|
FilterTypedLink?: TypedLinkSchemaAndFacetName;
|
|
3359
3771
|
/**
|
|
3772
|
+
* @public
|
|
3360
3773
|
* <p>The pagination token.</p>
|
|
3361
3774
|
*/
|
|
3362
3775
|
NextToken?: string;
|
|
3363
3776
|
/**
|
|
3777
|
+
* @public
|
|
3364
3778
|
* <p>The maximum number of results to retrieve.</p>
|
|
3365
3779
|
*/
|
|
3366
3780
|
MaxResults?: number;
|
|
3367
3781
|
/**
|
|
3782
|
+
* @public
|
|
3368
3783
|
* <p>The consistency level to execute the request at.</p>
|
|
3369
3784
|
*/
|
|
3370
3785
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3374,10 +3789,12 @@ export interface ListIncomingTypedLinksRequest {
|
|
|
3374
3789
|
*/
|
|
3375
3790
|
export interface ListIncomingTypedLinksResponse {
|
|
3376
3791
|
/**
|
|
3792
|
+
* @public
|
|
3377
3793
|
* <p>Returns one or more typed link specifiers as output.</p>
|
|
3378
3794
|
*/
|
|
3379
3795
|
LinkSpecifiers?: TypedLinkSpecifier[];
|
|
3380
3796
|
/**
|
|
3797
|
+
* @public
|
|
3381
3798
|
* <p>The pagination token.</p>
|
|
3382
3799
|
*/
|
|
3383
3800
|
NextToken?: string;
|
|
@@ -3387,26 +3804,32 @@ export interface ListIncomingTypedLinksResponse {
|
|
|
3387
3804
|
*/
|
|
3388
3805
|
export interface ListIndexRequest {
|
|
3389
3806
|
/**
|
|
3807
|
+
* @public
|
|
3390
3808
|
* <p>The ARN of the directory that the index exists in.</p>
|
|
3391
3809
|
*/
|
|
3392
3810
|
DirectoryArn: string | undefined;
|
|
3393
3811
|
/**
|
|
3812
|
+
* @public
|
|
3394
3813
|
* <p>Specifies the ranges of indexed values that you want to query.</p>
|
|
3395
3814
|
*/
|
|
3396
3815
|
RangesOnIndexedValues?: ObjectAttributeRange[];
|
|
3397
3816
|
/**
|
|
3817
|
+
* @public
|
|
3398
3818
|
* <p>The reference to the index to list.</p>
|
|
3399
3819
|
*/
|
|
3400
3820
|
IndexReference: ObjectReference | undefined;
|
|
3401
3821
|
/**
|
|
3822
|
+
* @public
|
|
3402
3823
|
* <p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href="http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Amazon Cloud Directory Limits</a>.</p>
|
|
3403
3824
|
*/
|
|
3404
3825
|
MaxResults?: number;
|
|
3405
3826
|
/**
|
|
3827
|
+
* @public
|
|
3406
3828
|
* <p>The pagination token.</p>
|
|
3407
3829
|
*/
|
|
3408
3830
|
NextToken?: string;
|
|
3409
3831
|
/**
|
|
3832
|
+
* @public
|
|
3410
3833
|
* <p>The consistency level to execute the request at.</p>
|
|
3411
3834
|
*/
|
|
3412
3835
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3416,10 +3839,12 @@ export interface ListIndexRequest {
|
|
|
3416
3839
|
*/
|
|
3417
3840
|
export interface ListIndexResponse {
|
|
3418
3841
|
/**
|
|
3842
|
+
* @public
|
|
3419
3843
|
* <p>The objects and indexed values attached to the index.</p>
|
|
3420
3844
|
*/
|
|
3421
3845
|
IndexAttachments?: IndexAttachment[];
|
|
3422
3846
|
/**
|
|
3847
|
+
* @public
|
|
3423
3848
|
* <p>The pagination token.</p>
|
|
3424
3849
|
*/
|
|
3425
3850
|
NextToken?: string;
|
|
@@ -3429,14 +3854,17 @@ export interface ListIndexResponse {
|
|
|
3429
3854
|
*/
|
|
3430
3855
|
export interface ListManagedSchemaArnsRequest {
|
|
3431
3856
|
/**
|
|
3857
|
+
* @public
|
|
3432
3858
|
* <p>The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.</p>
|
|
3433
3859
|
*/
|
|
3434
3860
|
SchemaArn?: string;
|
|
3435
3861
|
/**
|
|
3862
|
+
* @public
|
|
3436
3863
|
* <p>The pagination token.</p>
|
|
3437
3864
|
*/
|
|
3438
3865
|
NextToken?: string;
|
|
3439
3866
|
/**
|
|
3867
|
+
* @public
|
|
3440
3868
|
* <p>The maximum number of results to retrieve.</p>
|
|
3441
3869
|
*/
|
|
3442
3870
|
MaxResults?: number;
|
|
@@ -3446,10 +3874,12 @@ export interface ListManagedSchemaArnsRequest {
|
|
|
3446
3874
|
*/
|
|
3447
3875
|
export interface ListManagedSchemaArnsResponse {
|
|
3448
3876
|
/**
|
|
3877
|
+
* @public
|
|
3449
3878
|
* <p>The ARNs for all AWS managed schemas.</p>
|
|
3450
3879
|
*/
|
|
3451
3880
|
SchemaArns?: string[];
|
|
3452
3881
|
/**
|
|
3882
|
+
* @public
|
|
3453
3883
|
* <p>The pagination token.</p>
|
|
3454
3884
|
*/
|
|
3455
3885
|
NextToken?: string;
|
|
@@ -3459,29 +3889,35 @@ export interface ListManagedSchemaArnsResponse {
|
|
|
3459
3889
|
*/
|
|
3460
3890
|
export interface ListObjectAttributesRequest {
|
|
3461
3891
|
/**
|
|
3892
|
+
* @public
|
|
3462
3893
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
3463
3894
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
3464
3895
|
*/
|
|
3465
3896
|
DirectoryArn: string | undefined;
|
|
3466
3897
|
/**
|
|
3898
|
+
* @public
|
|
3467
3899
|
* <p>The reference that identifies the object whose attributes will be listed.</p>
|
|
3468
3900
|
*/
|
|
3469
3901
|
ObjectReference: ObjectReference | undefined;
|
|
3470
3902
|
/**
|
|
3903
|
+
* @public
|
|
3471
3904
|
* <p>The pagination token.</p>
|
|
3472
3905
|
*/
|
|
3473
3906
|
NextToken?: string;
|
|
3474
3907
|
/**
|
|
3908
|
+
* @public
|
|
3475
3909
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3476
3910
|
* number.</p>
|
|
3477
3911
|
*/
|
|
3478
3912
|
MaxResults?: number;
|
|
3479
3913
|
/**
|
|
3914
|
+
* @public
|
|
3480
3915
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
3481
3916
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
3482
3917
|
*/
|
|
3483
3918
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
3484
3919
|
/**
|
|
3920
|
+
* @public
|
|
3485
3921
|
* <p>Used to filter the list of object attributes that are associated with a certain
|
|
3486
3922
|
* facet.</p>
|
|
3487
3923
|
*/
|
|
@@ -3492,11 +3928,13 @@ export interface ListObjectAttributesRequest {
|
|
|
3492
3928
|
*/
|
|
3493
3929
|
export interface ListObjectAttributesResponse {
|
|
3494
3930
|
/**
|
|
3931
|
+
* @public
|
|
3495
3932
|
* <p>Attributes map that is associated with the object. <code>AttributeArn</code> is the
|
|
3496
3933
|
* key, and attribute value is the value.</p>
|
|
3497
3934
|
*/
|
|
3498
3935
|
Attributes?: AttributeKeyAndValue[];
|
|
3499
3936
|
/**
|
|
3937
|
+
* @public
|
|
3500
3938
|
* <p>The pagination token.</p>
|
|
3501
3939
|
*/
|
|
3502
3940
|
NextToken?: string;
|
|
@@ -3506,25 +3944,30 @@ export interface ListObjectAttributesResponse {
|
|
|
3506
3944
|
*/
|
|
3507
3945
|
export interface ListObjectChildrenRequest {
|
|
3508
3946
|
/**
|
|
3947
|
+
* @public
|
|
3509
3948
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
3510
3949
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
3511
3950
|
*/
|
|
3512
3951
|
DirectoryArn: string | undefined;
|
|
3513
3952
|
/**
|
|
3953
|
+
* @public
|
|
3514
3954
|
* <p>The reference that identifies the object for which child objects are being
|
|
3515
3955
|
* listed.</p>
|
|
3516
3956
|
*/
|
|
3517
3957
|
ObjectReference: ObjectReference | undefined;
|
|
3518
3958
|
/**
|
|
3959
|
+
* @public
|
|
3519
3960
|
* <p>The pagination token.</p>
|
|
3520
3961
|
*/
|
|
3521
3962
|
NextToken?: string;
|
|
3522
3963
|
/**
|
|
3964
|
+
* @public
|
|
3523
3965
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3524
3966
|
* number.</p>
|
|
3525
3967
|
*/
|
|
3526
3968
|
MaxResults?: number;
|
|
3527
3969
|
/**
|
|
3970
|
+
* @public
|
|
3528
3971
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
3529
3972
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
3530
3973
|
*/
|
|
@@ -3535,11 +3978,13 @@ export interface ListObjectChildrenRequest {
|
|
|
3535
3978
|
*/
|
|
3536
3979
|
export interface ListObjectChildrenResponse {
|
|
3537
3980
|
/**
|
|
3981
|
+
* @public
|
|
3538
3982
|
* <p>Children structure, which is a map with key as the <code>LinkName</code> and
|
|
3539
3983
|
* <code>ObjectIdentifier</code> as the value.</p>
|
|
3540
3984
|
*/
|
|
3541
3985
|
Children?: Record<string, string>;
|
|
3542
3986
|
/**
|
|
3987
|
+
* @public
|
|
3543
3988
|
* <p>The pagination token.</p>
|
|
3544
3989
|
*/
|
|
3545
3990
|
NextToken?: string;
|
|
@@ -3549,18 +3994,22 @@ export interface ListObjectChildrenResponse {
|
|
|
3549
3994
|
*/
|
|
3550
3995
|
export interface ListObjectParentPathsRequest {
|
|
3551
3996
|
/**
|
|
3997
|
+
* @public
|
|
3552
3998
|
* <p>The ARN of the directory to which the parent path applies.</p>
|
|
3553
3999
|
*/
|
|
3554
4000
|
DirectoryArn: string | undefined;
|
|
3555
4001
|
/**
|
|
4002
|
+
* @public
|
|
3556
4003
|
* <p>The reference that identifies the object whose parent paths are listed.</p>
|
|
3557
4004
|
*/
|
|
3558
4005
|
ObjectReference: ObjectReference | undefined;
|
|
3559
4006
|
/**
|
|
4007
|
+
* @public
|
|
3560
4008
|
* <p>The pagination token.</p>
|
|
3561
4009
|
*/
|
|
3562
4010
|
NextToken?: string;
|
|
3563
4011
|
/**
|
|
4012
|
+
* @public
|
|
3564
4013
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3565
4014
|
* number.</p>
|
|
3566
4015
|
*/
|
|
@@ -3571,11 +4020,13 @@ export interface ListObjectParentPathsRequest {
|
|
|
3571
4020
|
*/
|
|
3572
4021
|
export interface ListObjectParentPathsResponse {
|
|
3573
4022
|
/**
|
|
4023
|
+
* @public
|
|
3574
4024
|
* <p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the
|
|
3575
4025
|
* directory.</p>
|
|
3576
4026
|
*/
|
|
3577
4027
|
PathToObjectIdentifiersList?: PathToObjectIdentifiers[];
|
|
3578
4028
|
/**
|
|
4029
|
+
* @public
|
|
3579
4030
|
* <p>The pagination token.</p>
|
|
3580
4031
|
*/
|
|
3581
4032
|
NextToken?: string;
|
|
@@ -3598,30 +4049,36 @@ export declare class CannotListParentOfRootException extends __BaseException {
|
|
|
3598
4049
|
*/
|
|
3599
4050
|
export interface ListObjectParentsRequest {
|
|
3600
4051
|
/**
|
|
4052
|
+
* @public
|
|
3601
4053
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
3602
4054
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
3603
4055
|
*/
|
|
3604
4056
|
DirectoryArn: string | undefined;
|
|
3605
4057
|
/**
|
|
4058
|
+
* @public
|
|
3606
4059
|
* <p>The reference that identifies the object for which parent objects are being
|
|
3607
4060
|
* listed.</p>
|
|
3608
4061
|
*/
|
|
3609
4062
|
ObjectReference: ObjectReference | undefined;
|
|
3610
4063
|
/**
|
|
4064
|
+
* @public
|
|
3611
4065
|
* <p>The pagination token.</p>
|
|
3612
4066
|
*/
|
|
3613
4067
|
NextToken?: string;
|
|
3614
4068
|
/**
|
|
4069
|
+
* @public
|
|
3615
4070
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3616
4071
|
* number.</p>
|
|
3617
4072
|
*/
|
|
3618
4073
|
MaxResults?: number;
|
|
3619
4074
|
/**
|
|
4075
|
+
* @public
|
|
3620
4076
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
3621
4077
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
3622
4078
|
*/
|
|
3623
4079
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
3624
4080
|
/**
|
|
4081
|
+
* @public
|
|
3625
4082
|
* <p>When set to True, returns all <a>ListObjectParentsResponse$ParentLinks</a>. There could be multiple links between a parent-child pair.</p>
|
|
3626
4083
|
*/
|
|
3627
4084
|
IncludeAllLinksToEachParent?: boolean;
|
|
@@ -3631,15 +4088,18 @@ export interface ListObjectParentsRequest {
|
|
|
3631
4088
|
*/
|
|
3632
4089
|
export interface ListObjectParentsResponse {
|
|
3633
4090
|
/**
|
|
4091
|
+
* @public
|
|
3634
4092
|
* <p>The parent structure, which is a map with key as the <code>ObjectIdentifier</code> and
|
|
3635
4093
|
* LinkName as the value.</p>
|
|
3636
4094
|
*/
|
|
3637
4095
|
Parents?: Record<string, string>;
|
|
3638
4096
|
/**
|
|
4097
|
+
* @public
|
|
3639
4098
|
* <p>The pagination token.</p>
|
|
3640
4099
|
*/
|
|
3641
4100
|
NextToken?: string;
|
|
3642
4101
|
/**
|
|
4102
|
+
* @public
|
|
3643
4103
|
* <p>Returns a list of parent reference and LinkName Tuples.</p>
|
|
3644
4104
|
*/
|
|
3645
4105
|
ParentLinks?: ObjectIdentifierAndLinkNameTuple[];
|
|
@@ -3649,24 +4109,29 @@ export interface ListObjectParentsResponse {
|
|
|
3649
4109
|
*/
|
|
3650
4110
|
export interface ListObjectPoliciesRequest {
|
|
3651
4111
|
/**
|
|
4112
|
+
* @public
|
|
3652
4113
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
3653
4114
|
* where objects reside. For more information, see <a>arns</a>.</p>
|
|
3654
4115
|
*/
|
|
3655
4116
|
DirectoryArn: string | undefined;
|
|
3656
4117
|
/**
|
|
4118
|
+
* @public
|
|
3657
4119
|
* <p>Reference that identifies the object for which policies will be listed.</p>
|
|
3658
4120
|
*/
|
|
3659
4121
|
ObjectReference: ObjectReference | undefined;
|
|
3660
4122
|
/**
|
|
4123
|
+
* @public
|
|
3661
4124
|
* <p>The pagination token.</p>
|
|
3662
4125
|
*/
|
|
3663
4126
|
NextToken?: string;
|
|
3664
4127
|
/**
|
|
4128
|
+
* @public
|
|
3665
4129
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3666
4130
|
* number.</p>
|
|
3667
4131
|
*/
|
|
3668
4132
|
MaxResults?: number;
|
|
3669
4133
|
/**
|
|
4134
|
+
* @public
|
|
3670
4135
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
3671
4136
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
3672
4137
|
*/
|
|
@@ -3677,11 +4142,13 @@ export interface ListObjectPoliciesRequest {
|
|
|
3677
4142
|
*/
|
|
3678
4143
|
export interface ListObjectPoliciesResponse {
|
|
3679
4144
|
/**
|
|
4145
|
+
* @public
|
|
3680
4146
|
* <p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the
|
|
3681
4147
|
* object.</p>
|
|
3682
4148
|
*/
|
|
3683
4149
|
AttachedPolicyIds?: string[];
|
|
3684
4150
|
/**
|
|
4151
|
+
* @public
|
|
3685
4152
|
* <p>The pagination token.</p>
|
|
3686
4153
|
*/
|
|
3687
4154
|
NextToken?: string;
|
|
@@ -3691,34 +4158,41 @@ export interface ListObjectPoliciesResponse {
|
|
|
3691
4158
|
*/
|
|
3692
4159
|
export interface ListOutgoingTypedLinksRequest {
|
|
3693
4160
|
/**
|
|
4161
|
+
* @public
|
|
3694
4162
|
* <p>The Amazon Resource Name (ARN) of the directory where you want to list the typed
|
|
3695
4163
|
* links.</p>
|
|
3696
4164
|
*/
|
|
3697
4165
|
DirectoryArn: string | undefined;
|
|
3698
4166
|
/**
|
|
4167
|
+
* @public
|
|
3699
4168
|
* <p>A reference that identifies the object whose attributes will be listed.</p>
|
|
3700
4169
|
*/
|
|
3701
4170
|
ObjectReference: ObjectReference | undefined;
|
|
3702
4171
|
/**
|
|
4172
|
+
* @public
|
|
3703
4173
|
* <p>Provides range filters for multiple attributes. When providing ranges to typed link
|
|
3704
4174
|
* selection, any inexact ranges must be specified at the end. Any attributes that do not have a
|
|
3705
4175
|
* range specified are presumed to match the entire range.</p>
|
|
3706
4176
|
*/
|
|
3707
4177
|
FilterAttributeRanges?: TypedLinkAttributeRange[];
|
|
3708
4178
|
/**
|
|
4179
|
+
* @public
|
|
3709
4180
|
* <p>Filters are interpreted in the order of the attributes defined on the typed link facet,
|
|
3710
4181
|
* not the order they are supplied to any API calls.</p>
|
|
3711
4182
|
*/
|
|
3712
4183
|
FilterTypedLink?: TypedLinkSchemaAndFacetName;
|
|
3713
4184
|
/**
|
|
4185
|
+
* @public
|
|
3714
4186
|
* <p>The pagination token.</p>
|
|
3715
4187
|
*/
|
|
3716
4188
|
NextToken?: string;
|
|
3717
4189
|
/**
|
|
4190
|
+
* @public
|
|
3718
4191
|
* <p>The maximum number of results to retrieve.</p>
|
|
3719
4192
|
*/
|
|
3720
4193
|
MaxResults?: number;
|
|
3721
4194
|
/**
|
|
4195
|
+
* @public
|
|
3722
4196
|
* <p>The consistency level to execute the request at.</p>
|
|
3723
4197
|
*/
|
|
3724
4198
|
ConsistencyLevel?: ConsistencyLevel | string;
|
|
@@ -3728,10 +4202,12 @@ export interface ListOutgoingTypedLinksRequest {
|
|
|
3728
4202
|
*/
|
|
3729
4203
|
export interface ListOutgoingTypedLinksResponse {
|
|
3730
4204
|
/**
|
|
4205
|
+
* @public
|
|
3731
4206
|
* <p>Returns a typed link specifier as output.</p>
|
|
3732
4207
|
*/
|
|
3733
4208
|
TypedLinkSpecifiers?: TypedLinkSpecifier[];
|
|
3734
4209
|
/**
|
|
4210
|
+
* @public
|
|
3735
4211
|
* <p>The pagination token.</p>
|
|
3736
4212
|
*/
|
|
3737
4213
|
NextToken?: string;
|
|
@@ -3741,24 +4217,29 @@ export interface ListOutgoingTypedLinksResponse {
|
|
|
3741
4217
|
*/
|
|
3742
4218
|
export interface ListPolicyAttachmentsRequest {
|
|
3743
4219
|
/**
|
|
4220
|
+
* @public
|
|
3744
4221
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
3745
4222
|
* where objects reside. For more information, see <a>arns</a>.</p>
|
|
3746
4223
|
*/
|
|
3747
4224
|
DirectoryArn: string | undefined;
|
|
3748
4225
|
/**
|
|
4226
|
+
* @public
|
|
3749
4227
|
* <p>The reference that identifies the policy object.</p>
|
|
3750
4228
|
*/
|
|
3751
4229
|
PolicyReference: ObjectReference | undefined;
|
|
3752
4230
|
/**
|
|
4231
|
+
* @public
|
|
3753
4232
|
* <p>The pagination token.</p>
|
|
3754
4233
|
*/
|
|
3755
4234
|
NextToken?: string;
|
|
3756
4235
|
/**
|
|
4236
|
+
* @public
|
|
3757
4237
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3758
4238
|
* number.</p>
|
|
3759
4239
|
*/
|
|
3760
4240
|
MaxResults?: number;
|
|
3761
4241
|
/**
|
|
4242
|
+
* @public
|
|
3762
4243
|
* <p>Represents the manner and timing in which the successful write or update of an object
|
|
3763
4244
|
* is reflected in a subsequent read operation of that same object.</p>
|
|
3764
4245
|
*/
|
|
@@ -3769,10 +4250,12 @@ export interface ListPolicyAttachmentsRequest {
|
|
|
3769
4250
|
*/
|
|
3770
4251
|
export interface ListPolicyAttachmentsResponse {
|
|
3771
4252
|
/**
|
|
4253
|
+
* @public
|
|
3772
4254
|
* <p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>
|
|
3773
4255
|
*/
|
|
3774
4256
|
ObjectIdentifiers?: string[];
|
|
3775
4257
|
/**
|
|
4258
|
+
* @public
|
|
3776
4259
|
* <p>The pagination token.</p>
|
|
3777
4260
|
*/
|
|
3778
4261
|
NextToken?: string;
|
|
@@ -3782,14 +4265,17 @@ export interface ListPolicyAttachmentsResponse {
|
|
|
3782
4265
|
*/
|
|
3783
4266
|
export interface ListPublishedSchemaArnsRequest {
|
|
3784
4267
|
/**
|
|
4268
|
+
* @public
|
|
3785
4269
|
* <p>The response for <code>ListPublishedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>
|
|
3786
4270
|
*/
|
|
3787
4271
|
SchemaArn?: string;
|
|
3788
4272
|
/**
|
|
4273
|
+
* @public
|
|
3789
4274
|
* <p>The pagination token.</p>
|
|
3790
4275
|
*/
|
|
3791
4276
|
NextToken?: string;
|
|
3792
4277
|
/**
|
|
4278
|
+
* @public
|
|
3793
4279
|
* <p>The maximum number of results to retrieve.</p>
|
|
3794
4280
|
*/
|
|
3795
4281
|
MaxResults?: number;
|
|
@@ -3799,10 +4285,12 @@ export interface ListPublishedSchemaArnsRequest {
|
|
|
3799
4285
|
*/
|
|
3800
4286
|
export interface ListPublishedSchemaArnsResponse {
|
|
3801
4287
|
/**
|
|
4288
|
+
* @public
|
|
3802
4289
|
* <p>The ARNs of published schemas.</p>
|
|
3803
4290
|
*/
|
|
3804
4291
|
SchemaArns?: string[];
|
|
3805
4292
|
/**
|
|
4293
|
+
* @public
|
|
3806
4294
|
* <p>The pagination token.</p>
|
|
3807
4295
|
*/
|
|
3808
4296
|
NextToken?: string;
|
|
@@ -3825,16 +4313,19 @@ export declare class InvalidTaggingRequestException extends __BaseException {
|
|
|
3825
4313
|
*/
|
|
3826
4314
|
export interface ListTagsForResourceRequest {
|
|
3827
4315
|
/**
|
|
4316
|
+
* @public
|
|
3828
4317
|
* <p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for
|
|
3829
4318
|
* directories.</p>
|
|
3830
4319
|
*/
|
|
3831
4320
|
ResourceArn: string | undefined;
|
|
3832
4321
|
/**
|
|
4322
|
+
* @public
|
|
3833
4323
|
* <p>The pagination token. This is for future use. Currently pagination is not supported for
|
|
3834
4324
|
* tagging.</p>
|
|
3835
4325
|
*/
|
|
3836
4326
|
NextToken?: string;
|
|
3837
4327
|
/**
|
|
4328
|
+
* @public
|
|
3838
4329
|
* <p>The <code>MaxResults</code> parameter sets the maximum number of results returned in a
|
|
3839
4330
|
* single page. This is for future use and is not supported currently.</p>
|
|
3840
4331
|
*/
|
|
@@ -3846,10 +4337,12 @@ export interface ListTagsForResourceRequest {
|
|
|
3846
4337
|
*/
|
|
3847
4338
|
export interface Tag {
|
|
3848
4339
|
/**
|
|
4340
|
+
* @public
|
|
3849
4341
|
* <p>The key that is associated with the tag.</p>
|
|
3850
4342
|
*/
|
|
3851
4343
|
Key?: string;
|
|
3852
4344
|
/**
|
|
4345
|
+
* @public
|
|
3853
4346
|
* <p>The value that is associated with the tag.</p>
|
|
3854
4347
|
*/
|
|
3855
4348
|
Value?: string;
|
|
@@ -3859,10 +4352,12 @@ export interface Tag {
|
|
|
3859
4352
|
*/
|
|
3860
4353
|
export interface ListTagsForResourceResponse {
|
|
3861
4354
|
/**
|
|
4355
|
+
* @public
|
|
3862
4356
|
* <p>A list of tag key value pairs that are associated with the response.</p>
|
|
3863
4357
|
*/
|
|
3864
4358
|
Tags?: Tag[];
|
|
3865
4359
|
/**
|
|
4360
|
+
* @public
|
|
3866
4361
|
* <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
|
|
3867
4362
|
*/
|
|
3868
4363
|
NextToken?: string;
|
|
@@ -3872,19 +4367,23 @@ export interface ListTagsForResourceResponse {
|
|
|
3872
4367
|
*/
|
|
3873
4368
|
export interface ListTypedLinkFacetAttributesRequest {
|
|
3874
4369
|
/**
|
|
4370
|
+
* @public
|
|
3875
4371
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
3876
4372
|
* information, see <a>arns</a>.</p>
|
|
3877
4373
|
*/
|
|
3878
4374
|
SchemaArn: string | undefined;
|
|
3879
4375
|
/**
|
|
4376
|
+
* @public
|
|
3880
4377
|
* <p>The unique name of the typed link facet.</p>
|
|
3881
4378
|
*/
|
|
3882
4379
|
Name: string | undefined;
|
|
3883
4380
|
/**
|
|
4381
|
+
* @public
|
|
3884
4382
|
* <p>The pagination token.</p>
|
|
3885
4383
|
*/
|
|
3886
4384
|
NextToken?: string;
|
|
3887
4385
|
/**
|
|
4386
|
+
* @public
|
|
3888
4387
|
* <p>The maximum number of results to retrieve.</p>
|
|
3889
4388
|
*/
|
|
3890
4389
|
MaxResults?: number;
|
|
@@ -3894,10 +4393,12 @@ export interface ListTypedLinkFacetAttributesRequest {
|
|
|
3894
4393
|
*/
|
|
3895
4394
|
export interface ListTypedLinkFacetAttributesResponse {
|
|
3896
4395
|
/**
|
|
4396
|
+
* @public
|
|
3897
4397
|
* <p>An ordered set of attributes associate with the typed link.</p>
|
|
3898
4398
|
*/
|
|
3899
4399
|
Attributes?: TypedLinkAttributeDefinition[];
|
|
3900
4400
|
/**
|
|
4401
|
+
* @public
|
|
3901
4402
|
* <p>The pagination token.</p>
|
|
3902
4403
|
*/
|
|
3903
4404
|
NextToken?: string;
|
|
@@ -3907,15 +4408,18 @@ export interface ListTypedLinkFacetAttributesResponse {
|
|
|
3907
4408
|
*/
|
|
3908
4409
|
export interface ListTypedLinkFacetNamesRequest {
|
|
3909
4410
|
/**
|
|
4411
|
+
* @public
|
|
3910
4412
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
3911
4413
|
* information, see <a>arns</a>.</p>
|
|
3912
4414
|
*/
|
|
3913
4415
|
SchemaArn: string | undefined;
|
|
3914
4416
|
/**
|
|
4417
|
+
* @public
|
|
3915
4418
|
* <p>The pagination token.</p>
|
|
3916
4419
|
*/
|
|
3917
4420
|
NextToken?: string;
|
|
3918
4421
|
/**
|
|
4422
|
+
* @public
|
|
3919
4423
|
* <p>The maximum number of results to retrieve.</p>
|
|
3920
4424
|
*/
|
|
3921
4425
|
MaxResults?: number;
|
|
@@ -3925,10 +4429,12 @@ export interface ListTypedLinkFacetNamesRequest {
|
|
|
3925
4429
|
*/
|
|
3926
4430
|
export interface ListTypedLinkFacetNamesResponse {
|
|
3927
4431
|
/**
|
|
4432
|
+
* @public
|
|
3928
4433
|
* <p>The names of typed link facets that exist within the schema.</p>
|
|
3929
4434
|
*/
|
|
3930
4435
|
FacetNames?: string[];
|
|
3931
4436
|
/**
|
|
4437
|
+
* @public
|
|
3932
4438
|
* <p>The pagination token.</p>
|
|
3933
4439
|
*/
|
|
3934
4440
|
NextToken?: string;
|
|
@@ -3938,19 +4444,23 @@ export interface ListTypedLinkFacetNamesResponse {
|
|
|
3938
4444
|
*/
|
|
3939
4445
|
export interface LookupPolicyRequest {
|
|
3940
4446
|
/**
|
|
4447
|
+
* @public
|
|
3941
4448
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>.
|
|
3942
4449
|
* For more information, see <a>arns</a>.</p>
|
|
3943
4450
|
*/
|
|
3944
4451
|
DirectoryArn: string | undefined;
|
|
3945
4452
|
/**
|
|
4453
|
+
* @public
|
|
3946
4454
|
* <p>Reference that identifies the object whose policies will be looked up.</p>
|
|
3947
4455
|
*/
|
|
3948
4456
|
ObjectReference: ObjectReference | undefined;
|
|
3949
4457
|
/**
|
|
4458
|
+
* @public
|
|
3950
4459
|
* <p>The token to request the next page of results.</p>
|
|
3951
4460
|
*/
|
|
3952
4461
|
NextToken?: string;
|
|
3953
4462
|
/**
|
|
4463
|
+
* @public
|
|
3954
4464
|
* <p>The maximum number of items to be retrieved in a single call. This is an approximate
|
|
3955
4465
|
* number.</p>
|
|
3956
4466
|
*/
|
|
@@ -3961,12 +4471,14 @@ export interface LookupPolicyRequest {
|
|
|
3961
4471
|
*/
|
|
3962
4472
|
export interface LookupPolicyResponse {
|
|
3963
4473
|
/**
|
|
4474
|
+
* @public
|
|
3964
4475
|
* <p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and
|
|
3965
4476
|
* <code>PolicyType</code>. For more
|
|
3966
4477
|
* information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</p>
|
|
3967
4478
|
*/
|
|
3968
4479
|
PolicyToPathList?: PolicyToPath[];
|
|
3969
4480
|
/**
|
|
4481
|
+
* @public
|
|
3970
4482
|
* <p>The pagination token.</p>
|
|
3971
4483
|
*/
|
|
3972
4484
|
NextToken?: string;
|
|
@@ -3976,19 +4488,23 @@ export interface LookupPolicyResponse {
|
|
|
3976
4488
|
*/
|
|
3977
4489
|
export interface PublishSchemaRequest {
|
|
3978
4490
|
/**
|
|
4491
|
+
* @public
|
|
3979
4492
|
* <p>The Amazon Resource Name (ARN) that is associated with the development schema. For
|
|
3980
4493
|
* more information, see <a>arns</a>.</p>
|
|
3981
4494
|
*/
|
|
3982
4495
|
DevelopmentSchemaArn: string | undefined;
|
|
3983
4496
|
/**
|
|
4497
|
+
* @public
|
|
3984
4498
|
* <p>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</p>
|
|
3985
4499
|
*/
|
|
3986
4500
|
Version: string | undefined;
|
|
3987
4501
|
/**
|
|
4502
|
+
* @public
|
|
3988
4503
|
* <p>The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.</p>
|
|
3989
4504
|
*/
|
|
3990
4505
|
MinorVersion?: string;
|
|
3991
4506
|
/**
|
|
4507
|
+
* @public
|
|
3992
4508
|
* <p>The new name under which the schema will be published. If this is not provided, the
|
|
3993
4509
|
* development schema is considered.</p>
|
|
3994
4510
|
*/
|
|
@@ -3999,6 +4515,7 @@ export interface PublishSchemaRequest {
|
|
|
3999
4515
|
*/
|
|
4000
4516
|
export interface PublishSchemaResponse {
|
|
4001
4517
|
/**
|
|
4518
|
+
* @public
|
|
4002
4519
|
* <p>The ARN that is associated with the published schema. For more information, see <a>arns</a>.</p>
|
|
4003
4520
|
*/
|
|
4004
4521
|
PublishedSchemaArn?: string;
|
|
@@ -4034,10 +4551,12 @@ export declare class InvalidSchemaDocException extends __BaseException {
|
|
|
4034
4551
|
*/
|
|
4035
4552
|
export interface PutSchemaFromJsonRequest {
|
|
4036
4553
|
/**
|
|
4554
|
+
* @public
|
|
4037
4555
|
* <p>The ARN of the schema to update.</p>
|
|
4038
4556
|
*/
|
|
4039
4557
|
SchemaArn: string | undefined;
|
|
4040
4558
|
/**
|
|
4559
|
+
* @public
|
|
4041
4560
|
* <p>The replacement JSON schema.</p>
|
|
4042
4561
|
*/
|
|
4043
4562
|
Document: string | undefined;
|
|
@@ -4047,6 +4566,7 @@ export interface PutSchemaFromJsonRequest {
|
|
|
4047
4566
|
*/
|
|
4048
4567
|
export interface PutSchemaFromJsonResponse {
|
|
4049
4568
|
/**
|
|
4569
|
+
* @public
|
|
4050
4570
|
* <p>The ARN of the schema to update.</p>
|
|
4051
4571
|
*/
|
|
4052
4572
|
Arn?: string;
|
|
@@ -4056,14 +4576,17 @@ export interface PutSchemaFromJsonResponse {
|
|
|
4056
4576
|
*/
|
|
4057
4577
|
export interface RemoveFacetFromObjectRequest {
|
|
4058
4578
|
/**
|
|
4579
|
+
* @public
|
|
4059
4580
|
* <p>The ARN of the directory in which the object resides.</p>
|
|
4060
4581
|
*/
|
|
4061
4582
|
DirectoryArn: string | undefined;
|
|
4062
4583
|
/**
|
|
4584
|
+
* @public
|
|
4063
4585
|
* <p>The facet to remove. See <a>SchemaFacet</a> for details.</p>
|
|
4064
4586
|
*/
|
|
4065
4587
|
SchemaFacet: SchemaFacet | undefined;
|
|
4066
4588
|
/**
|
|
4589
|
+
* @public
|
|
4067
4590
|
* <p>A reference to the object to remove the facet from.</p>
|
|
4068
4591
|
*/
|
|
4069
4592
|
ObjectReference: ObjectReference | undefined;
|
|
@@ -4078,11 +4601,13 @@ export interface RemoveFacetFromObjectResponse {
|
|
|
4078
4601
|
*/
|
|
4079
4602
|
export interface TagResourceRequest {
|
|
4080
4603
|
/**
|
|
4604
|
+
* @public
|
|
4081
4605
|
* <p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for
|
|
4082
4606
|
* directories.</p>
|
|
4083
4607
|
*/
|
|
4084
4608
|
ResourceArn: string | undefined;
|
|
4085
4609
|
/**
|
|
4610
|
+
* @public
|
|
4086
4611
|
* <p>A list of tag key-value pairs.</p>
|
|
4087
4612
|
*/
|
|
4088
4613
|
Tags: Tag[] | undefined;
|
|
@@ -4097,11 +4622,13 @@ export interface TagResourceResponse {
|
|
|
4097
4622
|
*/
|
|
4098
4623
|
export interface UntagResourceRequest {
|
|
4099
4624
|
/**
|
|
4625
|
+
* @public
|
|
4100
4626
|
* <p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for
|
|
4101
4627
|
* directories.</p>
|
|
4102
4628
|
*/
|
|
4103
4629
|
ResourceArn: string | undefined;
|
|
4104
4630
|
/**
|
|
4631
|
+
* @public
|
|
4105
4632
|
* <p>Keys of the tag that need to be removed from the resource.</p>
|
|
4106
4633
|
*/
|
|
4107
4634
|
TagKeys: string[] | undefined;
|
|
@@ -4131,10 +4658,12 @@ export declare class InvalidFacetUpdateException extends __BaseException {
|
|
|
4131
4658
|
*/
|
|
4132
4659
|
export interface FacetAttributeUpdate {
|
|
4133
4660
|
/**
|
|
4661
|
+
* @public
|
|
4134
4662
|
* <p>The attribute to update.</p>
|
|
4135
4663
|
*/
|
|
4136
4664
|
Attribute?: FacetAttribute;
|
|
4137
4665
|
/**
|
|
4666
|
+
* @public
|
|
4138
4667
|
* <p>The action to perform when updating the attribute.</p>
|
|
4139
4668
|
*/
|
|
4140
4669
|
Action?: UpdateActionType | string;
|
|
@@ -4144,21 +4673,25 @@ export interface FacetAttributeUpdate {
|
|
|
4144
4673
|
*/
|
|
4145
4674
|
export interface UpdateFacetRequest {
|
|
4146
4675
|
/**
|
|
4676
|
+
* @public
|
|
4147
4677
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>.
|
|
4148
4678
|
* For more information, see <a>arns</a>.</p>
|
|
4149
4679
|
*/
|
|
4150
4680
|
SchemaArn: string | undefined;
|
|
4151
4681
|
/**
|
|
4682
|
+
* @public
|
|
4152
4683
|
* <p>The name of the facet.</p>
|
|
4153
4684
|
*/
|
|
4154
4685
|
Name: string | undefined;
|
|
4155
4686
|
/**
|
|
4687
|
+
* @public
|
|
4156
4688
|
* <p>List of attributes that need to be updated in a given schema <a>Facet</a>.
|
|
4157
4689
|
* Each attribute is followed by <code>AttributeAction</code>, which specifies the type of update
|
|
4158
4690
|
* operation to perform. </p>
|
|
4159
4691
|
*/
|
|
4160
4692
|
AttributeUpdates?: FacetAttributeUpdate[];
|
|
4161
4693
|
/**
|
|
4694
|
+
* @public
|
|
4162
4695
|
* <p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>
|
|
4163
4696
|
*/
|
|
4164
4697
|
ObjectType?: ObjectType | string;
|
|
@@ -4173,14 +4706,17 @@ export interface UpdateFacetResponse {
|
|
|
4173
4706
|
*/
|
|
4174
4707
|
export interface UpdateLinkAttributesRequest {
|
|
4175
4708
|
/**
|
|
4709
|
+
* @public
|
|
4176
4710
|
* <p>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>
|
|
4177
4711
|
*/
|
|
4178
4712
|
DirectoryArn: string | undefined;
|
|
4179
4713
|
/**
|
|
4714
|
+
* @public
|
|
4180
4715
|
* <p>Allows a typed link specifier to be accepted as input.</p>
|
|
4181
4716
|
*/
|
|
4182
4717
|
TypedLinkSpecifier: TypedLinkSpecifier | undefined;
|
|
4183
4718
|
/**
|
|
4719
|
+
* @public
|
|
4184
4720
|
* <p>The attributes update structure.</p>
|
|
4185
4721
|
*/
|
|
4186
4722
|
AttributeUpdates: LinkAttributeUpdate[] | undefined;
|
|
@@ -4195,15 +4731,18 @@ export interface UpdateLinkAttributesResponse {
|
|
|
4195
4731
|
*/
|
|
4196
4732
|
export interface UpdateObjectAttributesRequest {
|
|
4197
4733
|
/**
|
|
4734
|
+
* @public
|
|
4198
4735
|
* <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>
|
|
4199
4736
|
* where the object resides. For more information, see <a>arns</a>.</p>
|
|
4200
4737
|
*/
|
|
4201
4738
|
DirectoryArn: string | undefined;
|
|
4202
4739
|
/**
|
|
4740
|
+
* @public
|
|
4203
4741
|
* <p>The reference that identifies the object.</p>
|
|
4204
4742
|
*/
|
|
4205
4743
|
ObjectReference: ObjectReference | undefined;
|
|
4206
4744
|
/**
|
|
4745
|
+
* @public
|
|
4207
4746
|
* <p>The attributes update structure.</p>
|
|
4208
4747
|
*/
|
|
4209
4748
|
AttributeUpdates: ObjectAttributeUpdate[] | undefined;
|
|
@@ -4213,6 +4752,7 @@ export interface UpdateObjectAttributesRequest {
|
|
|
4213
4752
|
*/
|
|
4214
4753
|
export interface UpdateObjectAttributesResponse {
|
|
4215
4754
|
/**
|
|
4755
|
+
* @public
|
|
4216
4756
|
* <p>The <code>ObjectIdentifier</code> of the updated object.</p>
|
|
4217
4757
|
*/
|
|
4218
4758
|
ObjectIdentifier?: string;
|
|
@@ -4222,11 +4762,13 @@ export interface UpdateObjectAttributesResponse {
|
|
|
4222
4762
|
*/
|
|
4223
4763
|
export interface UpdateSchemaRequest {
|
|
4224
4764
|
/**
|
|
4765
|
+
* @public
|
|
4225
4766
|
* <p>The Amazon Resource Name (ARN) of the development schema. For more information, see
|
|
4226
4767
|
* <a>arns</a>.</p>
|
|
4227
4768
|
*/
|
|
4228
4769
|
SchemaArn: string | undefined;
|
|
4229
4770
|
/**
|
|
4771
|
+
* @public
|
|
4230
4772
|
* <p>The name of the schema.</p>
|
|
4231
4773
|
*/
|
|
4232
4774
|
Name: string | undefined;
|
|
@@ -4236,6 +4778,7 @@ export interface UpdateSchemaRequest {
|
|
|
4236
4778
|
*/
|
|
4237
4779
|
export interface UpdateSchemaResponse {
|
|
4238
4780
|
/**
|
|
4781
|
+
* @public
|
|
4239
4782
|
* <p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>
|
|
4240
4783
|
*/
|
|
4241
4784
|
SchemaArn?: string;
|
|
@@ -4246,10 +4789,12 @@ export interface UpdateSchemaResponse {
|
|
|
4246
4789
|
*/
|
|
4247
4790
|
export interface TypedLinkFacetAttributeUpdate {
|
|
4248
4791
|
/**
|
|
4792
|
+
* @public
|
|
4249
4793
|
* <p>The attribute to update.</p>
|
|
4250
4794
|
*/
|
|
4251
4795
|
Attribute: TypedLinkAttributeDefinition | undefined;
|
|
4252
4796
|
/**
|
|
4797
|
+
* @public
|
|
4253
4798
|
* <p>The action to perform when updating the attribute.</p>
|
|
4254
4799
|
*/
|
|
4255
4800
|
Action: UpdateActionType | string | undefined;
|
|
@@ -4259,19 +4804,23 @@ export interface TypedLinkFacetAttributeUpdate {
|
|
|
4259
4804
|
*/
|
|
4260
4805
|
export interface UpdateTypedLinkFacetRequest {
|
|
4261
4806
|
/**
|
|
4807
|
+
* @public
|
|
4262
4808
|
* <p>The Amazon Resource Name (ARN) that is associated with the schema. For more
|
|
4263
4809
|
* information, see <a>arns</a>.</p>
|
|
4264
4810
|
*/
|
|
4265
4811
|
SchemaArn: string | undefined;
|
|
4266
4812
|
/**
|
|
4813
|
+
* @public
|
|
4267
4814
|
* <p>The unique name of the typed link facet.</p>
|
|
4268
4815
|
*/
|
|
4269
4816
|
Name: string | undefined;
|
|
4270
4817
|
/**
|
|
4818
|
+
* @public
|
|
4271
4819
|
* <p>Attributes update structure.</p>
|
|
4272
4820
|
*/
|
|
4273
4821
|
AttributeUpdates: TypedLinkFacetAttributeUpdate[] | undefined;
|
|
4274
4822
|
/**
|
|
4823
|
+
* @public
|
|
4275
4824
|
* <p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed
|
|
4276
4825
|
* links considers the order that the attributes are defined on the typed link facet. When
|
|
4277
4826
|
* providing ranges to a typed link selection, any inexact ranges must be specified at the end.
|
|
@@ -4304,14 +4853,17 @@ export declare class IncompatibleSchemaException extends __BaseException {
|
|
|
4304
4853
|
*/
|
|
4305
4854
|
export interface UpgradeAppliedSchemaRequest {
|
|
4306
4855
|
/**
|
|
4856
|
+
* @public
|
|
4307
4857
|
* <p>The revision of the published schema to upgrade the directory to.</p>
|
|
4308
4858
|
*/
|
|
4309
4859
|
PublishedSchemaArn: string | undefined;
|
|
4310
4860
|
/**
|
|
4861
|
+
* @public
|
|
4311
4862
|
* <p>The ARN for the directory to which the upgraded schema will be applied.</p>
|
|
4312
4863
|
*/
|
|
4313
4864
|
DirectoryArn: string | undefined;
|
|
4314
4865
|
/**
|
|
4866
|
+
* @public
|
|
4315
4867
|
* <p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>
|
|
4316
4868
|
*/
|
|
4317
4869
|
DryRun?: boolean;
|
|
@@ -4321,10 +4873,12 @@ export interface UpgradeAppliedSchemaRequest {
|
|
|
4321
4873
|
*/
|
|
4322
4874
|
export interface UpgradeAppliedSchemaResponse {
|
|
4323
4875
|
/**
|
|
4876
|
+
* @public
|
|
4324
4877
|
* <p>The ARN of the upgraded schema that is returned as part of the response.</p>
|
|
4325
4878
|
*/
|
|
4326
4879
|
UpgradedSchemaArn?: string;
|
|
4327
4880
|
/**
|
|
4881
|
+
* @public
|
|
4328
4882
|
* <p>The ARN of the directory that is returned as part of the response.</p>
|
|
4329
4883
|
*/
|
|
4330
4884
|
DirectoryArn?: string;
|
|
@@ -4334,18 +4888,22 @@ export interface UpgradeAppliedSchemaResponse {
|
|
|
4334
4888
|
*/
|
|
4335
4889
|
export interface UpgradePublishedSchemaRequest {
|
|
4336
4890
|
/**
|
|
4891
|
+
* @public
|
|
4337
4892
|
* <p>The ARN of the development schema with the changes used for the upgrade.</p>
|
|
4338
4893
|
*/
|
|
4339
4894
|
DevelopmentSchemaArn: string | undefined;
|
|
4340
4895
|
/**
|
|
4896
|
+
* @public
|
|
4341
4897
|
* <p>The ARN of the published schema to be upgraded.</p>
|
|
4342
4898
|
*/
|
|
4343
4899
|
PublishedSchemaArn: string | undefined;
|
|
4344
4900
|
/**
|
|
4901
|
+
* @public
|
|
4345
4902
|
* <p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>
|
|
4346
4903
|
*/
|
|
4347
4904
|
MinorVersion: string | undefined;
|
|
4348
4905
|
/**
|
|
4906
|
+
* @public
|
|
4349
4907
|
* <p>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</p>
|
|
4350
4908
|
*/
|
|
4351
4909
|
DryRun?: boolean;
|
|
@@ -4355,6 +4913,7 @@ export interface UpgradePublishedSchemaRequest {
|
|
|
4355
4913
|
*/
|
|
4356
4914
|
export interface UpgradePublishedSchemaResponse {
|
|
4357
4915
|
/**
|
|
4916
|
+
* @public
|
|
4358
4917
|
* <p>The ARN of the upgraded schema that is returned as part of the response.</p>
|
|
4359
4918
|
*/
|
|
4360
4919
|
UpgradedSchemaArn?: string;
|