AWS Directory Service - API Reference

170 Pages·2017·1.11 MB·English

by  Amazon Web Services

AWS Directory Service
API Reference
AWS Directory Service API Reference
AWS Directory Service: API Reference
Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be affiliated with, connected to, or sponsored by Amazon.
AWS Directory Service API Reference
Table of Contents
Welcome........................................................................................................................................... 1
Actions............................................................................................................................................. 2
AcceptSharedDirectory................................................................................................................ 4
Request Syntax.................................................................................................................. 4
Request Parameters............................................................................................................ 4
Response Syntax................................................................................................................ 4
Response Elements............................................................................................................. 4
Errors............................................................................................................................... 5
See Also............................................................................................................................ 5
AddIpRoutes.............................................................................................................................. 6
Request Syntax.................................................................................................................. 6
Request Parameters............................................................................................................ 6
Response Elements............................................................................................................. 7
Errors............................................................................................................................... 7
Examples........................................................................................................................... 8
See Also............................................................................................................................ 9
AddRegion............................................................................................................................... 10
Request Syntax................................................................................................................ 10
Request Parameters.......................................................................................................... 10
Response Elements........................................................................................................... 10
Errors.............................................................................................................................. 10
See Also.......................................................................................................................... 11
AddTagsToResource.................................................................................................................. 13
Request Syntax................................................................................................................ 13
Request Parameters.......................................................................................................... 13
Response Elements........................................................................................................... 13
Errors.............................................................................................................................. 13
Examples......................................................................................................................... 14
See Also.......................................................................................................................... 15
CancelSchemaExtension............................................................................................................ 16
Request Syntax................................................................................................................ 16
Request Parameters.......................................................................................................... 16
Response Elements........................................................................................................... 16
Errors.............................................................................................................................. 16
Examples......................................................................................................................... 17
See Also.......................................................................................................................... 17
ConnectDirectory...................................................................................................................... 19
Request Syntax................................................................................................................ 19
Request Parameters.......................................................................................................... 19
Response Syntax.............................................................................................................. 20
Response Elements........................................................................................................... 20
Errors.............................................................................................................................. 21
Examples......................................................................................................................... 21
See Also.......................................................................................................................... 22
CreateAlias.............................................................................................................................. 23
Request Syntax................................................................................................................ 23
Request Parameters.......................................................................................................... 23
Response Syntax.............................................................................................................. 23
Response Elements........................................................................................................... 23
Errors.............................................................................................................................. 24
Examples......................................................................................................................... 24
See Also.......................................................................................................................... 25
CreateComputer....................................................................................................................... 26
Request Syntax................................................................................................................ 26
iii
AWS Directory Service API Reference
Request Parameters.......................................................................................................... 26
Response Syntax.............................................................................................................. 27
Response Elements........................................................................................................... 27
Errors.............................................................................................................................. 27
Examples......................................................................................................................... 28
See Also.......................................................................................................................... 29
CreateConditionalForwarder....................................................................................................... 30
Request Syntax................................................................................................................ 30
Request Parameters.......................................................................................................... 30
Response Elements........................................................................................................... 30
Errors.............................................................................................................................. 31
Examples......................................................................................................................... 31
See Also.......................................................................................................................... 32
CreateDirectory........................................................................................................................ 33
Request Syntax................................................................................................................ 33
Request Parameters.......................................................................................................... 33
Response Syntax.............................................................................................................. 34
Response Elements........................................................................................................... 35
Errors.............................................................................................................................. 35
Examples......................................................................................................................... 35
See Also.......................................................................................................................... 36
CreateLogSubscription.............................................................................................................. 37
Request Syntax................................................................................................................ 37
Request Parameters.......................................................................................................... 37
Response Elements........................................................................................................... 37
Errors.............................................................................................................................. 37
See Also.......................................................................................................................... 38
CreateMicrosoftAD.................................................................................................................... 39
Request Syntax................................................................................................................ 39
Request Parameters.......................................................................................................... 39
Response Syntax.............................................................................................................. 40
Response Elements........................................................................................................... 40
Errors.............................................................................................................................. 41
Examples......................................................................................................................... 41
See Also.......................................................................................................................... 42
CreateSnapshot........................................................................................................................ 43
Request Syntax................................................................................................................ 43
Request Parameters.......................................................................................................... 43
Response Syntax.............................................................................................................. 43
Response Elements........................................................................................................... 43
Errors.............................................................................................................................. 44
Examples......................................................................................................................... 44
See Also.......................................................................................................................... 45
CreateTrust.............................................................................................................................. 46
Request Syntax................................................................................................................ 46
Request Parameters.......................................................................................................... 46
Response Syntax.............................................................................................................. 47
Response Elements........................................................................................................... 47
Errors.............................................................................................................................. 48
Examples......................................................................................................................... 48
See Also.......................................................................................................................... 49
DeleteConditionalForwarder....................................................................................................... 50
Request Syntax................................................................................................................ 50
Request Parameters.......................................................................................................... 50
Response Elements........................................................................................................... 50
Errors.............................................................................................................................. 50
Examples......................................................................................................................... 51
iv
AWS Directory Service API Reference
See Also.......................................................................................................................... 52
DeleteDirectory........................................................................................................................ 53
Request Syntax................................................................................................................ 53
Request Parameters.......................................................................................................... 53
Response Syntax.............................................................................................................. 53
Response Elements........................................................................................................... 53
Errors.............................................................................................................................. 53
Examples......................................................................................................................... 54
See Also.......................................................................................................................... 54
DeleteLogSubscription.............................................................................................................. 56
Request Syntax................................................................................................................ 56
Request Parameters.......................................................................................................... 56
Response Elements........................................................................................................... 56
Errors.............................................................................................................................. 56
See Also.......................................................................................................................... 57
DeleteSnapshot........................................................................................................................ 58
Request Syntax................................................................................................................ 58
Request Parameters.......................................................................................................... 58
Response Syntax.............................................................................................................. 58
Response Elements........................................................................................................... 58
Errors.............................................................................................................................. 58
Examples......................................................................................................................... 59
See Also.......................................................................................................................... 59
DeleteTrust.............................................................................................................................. 61
Request Syntax................................................................................................................ 61
Request Parameters.......................................................................................................... 61
Response Syntax.............................................................................................................. 61
Response Elements........................................................................................................... 61
Errors.............................................................................................................................. 62
Examples......................................................................................................................... 62
See Also.......................................................................................................................... 63
DeregisterCertificate................................................................................................................. 64
Request Syntax................................................................................................................ 64
Request Parameters.......................................................................................................... 64
Response Elements........................................................................................................... 64
Errors.............................................................................................................................. 64
See Also.......................................................................................................................... 65
DeregisterEventTopic................................................................................................................ 66
Request Syntax................................................................................................................ 66
Request Parameters.......................................................................................................... 66
Response Elements........................................................................................................... 66
Errors.............................................................................................................................. 66
Examples......................................................................................................................... 67
See Also.......................................................................................................................... 67
DescribeCertificate.................................................................................................................... 69
Request Syntax................................................................................................................ 69
Request Parameters.......................................................................................................... 69
Response Syntax.............................................................................................................. 69
Response Elements........................................................................................................... 69
Errors.............................................................................................................................. 70
See Also.......................................................................................................................... 70
DescribeClientAuthenticationSettings.......................................................................................... 72
Request Syntax................................................................................................................ 72
Request Parameters.......................................................................................................... 72
Response Syntax.............................................................................................................. 73
Response Elements........................................................................................................... 73
Errors.............................................................................................................................. 73
v
AWS Directory Service API Reference
See Also.......................................................................................................................... 74
DescribeConditionalForwarders.................................................................................................. 75
Request Syntax................................................................................................................ 75
Request Parameters.......................................................................................................... 75
Response Syntax.............................................................................................................. 75
Response Elements........................................................................................................... 75
Errors.............................................................................................................................. 76
Examples......................................................................................................................... 76
See Also.......................................................................................................................... 77
DescribeDirectories................................................................................................................... 78
Request Syntax................................................................................................................ 78
Request Parameters.......................................................................................................... 78
Response Syntax.............................................................................................................. 79
Response Elements........................................................................................................... 80
Errors.............................................................................................................................. 80
Examples......................................................................................................................... 81
See Also.......................................................................................................................... 82
DescribeDomainControllers........................................................................................................ 83
Request Syntax................................................................................................................ 83
Request Parameters.......................................................................................................... 83
Response Syntax.............................................................................................................. 83
Response Elements........................................................................................................... 84
Errors.............................................................................................................................. 84
See Also.......................................................................................................................... 85
DescribeEventTopics.................................................................................................................. 86
Request Syntax................................................................................................................ 86
Request Parameters.......................................................................................................... 86
Response Syntax.............................................................................................................. 86
Response Elements........................................................................................................... 87
Errors.............................................................................................................................. 87
Examples......................................................................................................................... 87
See Also.......................................................................................................................... 88
DescribeLDAPSSettings............................................................................................................. 89
Request Syntax................................................................................................................ 89
Request Parameters.......................................................................................................... 89
Response Syntax.............................................................................................................. 89
Response Elements........................................................................................................... 90
Errors.............................................................................................................................. 90
See Also.......................................................................................................................... 91
DescribeRegions....................................................................................................................... 92
Request Syntax................................................................................................................ 92
Request Parameters.......................................................................................................... 92
Response Syntax.............................................................................................................. 92
Response Elements........................................................................................................... 93
Errors.............................................................................................................................. 93
See Also.......................................................................................................................... 94
DescribeSettings....................................................................................................................... 95
Request Syntax................................................................................................................ 95
Request Parameters.......................................................................................................... 95
Response Syntax.............................................................................................................. 95
Response Elements........................................................................................................... 96
Errors.............................................................................................................................. 96
See Also.......................................................................................................................... 97
DescribeSharedDirectories......................................................................................................... 98
Request Syntax................................................................................................................ 98
Request Parameters.......................................................................................................... 98
Response Syntax.............................................................................................................. 98
vi
AWS Directory Service API Reference
Response Elements........................................................................................................... 99
Errors.............................................................................................................................. 99
See Also........................................................................................................................ 100
DescribeSnapshots.................................................................................................................. 101
Request Syntax.............................................................................................................. 101
Request Parameters........................................................................................................ 101
Response Syntax............................................................................................................ 102
Response Elements......................................................................................................... 102
Errors............................................................................................................................ 102
Examples....................................................................................................................... 103
See Also........................................................................................................................ 104
DescribeTrusts........................................................................................................................ 105
Request Syntax.............................................................................................................. 105
Request Parameters........................................................................................................ 105
Response Syntax............................................................................................................ 106
Response Elements......................................................................................................... 106
Errors............................................................................................................................ 106
Examples....................................................................................................................... 107
See Also........................................................................................................................ 108
DescribeUpdateDirectory......................................................................................................... 109
Request Syntax.............................................................................................................. 109
Request Parameters........................................................................................................ 109
Response Syntax............................................................................................................ 109
Response Elements......................................................................................................... 110
Errors............................................................................................................................ 110
See Also........................................................................................................................ 111
DisableClientAuthentication..................................................................................................... 112
Request Syntax.............................................................................................................. 112
Request Parameters........................................................................................................ 112
Response Elements......................................................................................................... 112
Errors............................................................................................................................ 112
See Also........................................................................................................................ 113
DisableLDAPS ......................................................................................................................... 114
Request Syntax.............................................................................................................. 114
Request Parameters........................................................................................................ 114
Response Elements......................................................................................................... 114
Errors............................................................................................................................ 114
See Also........................................................................................................................ 115
DisableRadius......................................................................................................................... 116
Request Syntax.............................................................................................................. 116
Request Parameters........................................................................................................ 116
Response Elements......................................................................................................... 116
Errors............................................................................................................................ 116
Examples....................................................................................................................... 116
See Also........................................................................................................................ 117
DisableSso............................................................................................................................. 118
Request Syntax.............................................................................................................. 118
Request Parameters........................................................................................................ 118
Response Elements......................................................................................................... 118
Errors............................................................................................................................ 119
Examples....................................................................................................................... 119
See Also........................................................................................................................ 120
EnableClientAuthentication...................................................................................................... 121
Request Syntax.............................................................................................................. 121
Request Parameters........................................................................................................ 121
Response Elements......................................................................................................... 121
Errors............................................................................................................................ 121
vii
AWS Directory Service API Reference
See Also........................................................................................................................ 122
EnableLDAPS......................................................................................................................... 123
Request Syntax.............................................................................................................. 123
Request Parameters........................................................................................................ 123
Response Elements......................................................................................................... 123
Errors............................................................................................................................ 123
See Also........................................................................................................................ 124
EnableRadius......................................................................................................................... 125
Request Syntax.............................................................................................................. 125
Request Parameters........................................................................................................ 125
Response Elements......................................................................................................... 125
Errors............................................................................................................................ 125
Examples....................................................................................................................... 126
See Also........................................................................................................................ 127
EnableSso.............................................................................................................................. 128
Request Syntax.............................................................................................................. 128
Request Parameters........................................................................................................ 128
Response Elements......................................................................................................... 128
Errors............................................................................................................................ 129
Examples....................................................................................................................... 129
See Also........................................................................................................................ 130
GetDirectoryLimits.................................................................................................................. 131
Response Syntax............................................................................................................ 131
Response Elements......................................................................................................... 131
Errors............................................................................................................................ 131
Examples....................................................................................................................... 131
See Also........................................................................................................................ 132
GetSnapshotLimits.................................................................................................................. 134
Request Syntax.............................................................................................................. 134
Request Parameters........................................................................................................ 134
Response Syntax............................................................................................................ 134
Response Elements......................................................................................................... 134
Errors............................................................................................................................ 134
Examples....................................................................................................................... 135
See Also........................................................................................................................ 135
ListCertificates....................................................................................................................... 137
Request Syntax.............................................................................................................. 137
Request Parameters........................................................................................................ 137
Response Syntax............................................................................................................ 137
Response Elements......................................................................................................... 138
Errors............................................................................................................................ 138
See Also........................................................................................................................ 139
ListIpRoutes........................................................................................................................... 140
Request Syntax.............................................................................................................. 140
Request Parameters........................................................................................................ 140
Response Syntax............................................................................................................ 140
Response Elements......................................................................................................... 141
Errors............................................................................................................................ 141
Examples....................................................................................................................... 141
See Also........................................................................................................................ 142
ListLogSubscriptions............................................................................................................... 144
Request Syntax.............................................................................................................. 144
Request Parameters........................................................................................................ 144
Response Syntax............................................................................................................ 144
Response Elements......................................................................................................... 145
Errors............................................................................................................................ 145
See Also........................................................................................................................ 145
viii
AWS Directory Service API Reference
ListSchemaExtensions............................................................................................................. 147
Request Syntax.............................................................................................................. 147
Request Parameters........................................................................................................ 147
Response Syntax............................................................................................................ 147
Response Elements......................................................................................................... 148
Errors............................................................................................................................ 148
Examples....................................................................................................................... 148
See Also........................................................................................................................ 149
ListTagsForResource................................................................................................................ 151
Request Syntax.............................................................................................................. 151
Request Parameters........................................................................................................ 151
Response Syntax............................................................................................................ 151
Response Elements......................................................................................................... 152
Errors............................................................................................................................ 152
Examples....................................................................................................................... 152
See Also........................................................................................................................ 153
RegisterCertificate.................................................................................................................. 154
Request Syntax.............................................................................................................. 154
Request Parameters........................................................................................................ 154
Response Syntax............................................................................................................ 155
Response Elements......................................................................................................... 155
Errors............................................................................................................................ 155
See Also........................................................................................................................ 156
RegisterEventTopic.................................................................................................................. 157
Request Syntax.............................................................................................................. 157
Request Parameters........................................................................................................ 157
Response Elements......................................................................................................... 157
Errors............................................................................................................................ 157
Examples....................................................................................................................... 158
See Also........................................................................................................................ 158
RejectSharedDirectory............................................................................................................. 160
Request Syntax.............................................................................................................. 160
Request Parameters........................................................................................................ 160
Response Syntax............................................................................................................ 160
Response Elements......................................................................................................... 160
Errors............................................................................................................................ 160
See Also........................................................................................................................ 161
RemoveIpRoutes..................................................................................................................... 162
Request Syntax.............................................................................................................. 162
Request Parameters........................................................................................................ 162
Response Elements......................................................................................................... 162
Errors............................................................................................................................ 162
Examples....................................................................................................................... 163
See Also........................................................................................................................ 163
RemoveRegion....................................................................................................................... 165
Request Syntax.............................................................................................................. 165
Request Parameters........................................................................................................ 165
Response Elements......................................................................................................... 165
Errors............................................................................................................................ 165
See Also........................................................................................................................ 166
RemoveTagsFromResource....................................................................................................... 167
Request Syntax.............................................................................................................. 167
Request Parameters........................................................................................................ 167
Response Elements......................................................................................................... 167
Errors............................................................................................................................ 167
Examples....................................................................................................................... 168
See Also........................................................................................................................ 168
ix
AWS Directory Service API Reference
ResetUserPassword................................................................................................................. 170
Request Syntax.............................................................................................................. 170
Request Parameters........................................................................................................ 170
Response Elements......................................................................................................... 171
Errors............................................................................................................................ 171
See Also........................................................................................................................ 171
RestoreFromSnapshot............................................................................................................. 173
Request Syntax.............................................................................................................. 173
Request Parameters........................................................................................................ 173
Response Elements......................................................................................................... 173
Errors............................................................................................................................ 173
Examples....................................................................................................................... 174
See Also........................................................................................................................ 174
ShareDirectory....................................................................................................................... 176
Request Syntax.............................................................................................................. 176
Request Parameters........................................................................................................ 176
Response Syntax............................................................................................................ 177
Response Elements......................................................................................................... 177
Errors............................................................................................................................ 177
See Also........................................................................................................................ 178
StartSchemaExtension............................................................................................................. 180
Request Syntax.............................................................................................................. 180
Request Parameters........................................................................................................ 180
Response Syntax............................................................................................................ 181
Response Elements......................................................................................................... 181
Errors............................................................................................................................ 181
Examples....................................................................................................................... 182
See Also........................................................................................................................ 183
UnshareDirectory.................................................................................................................... 184
Request Syntax.............................................................................................................. 184
Request Parameters........................................................................................................ 184
Response Syntax............................................................................................................ 184
Response Elements......................................................................................................... 184
Errors............................................................................................................................ 185
See Also........................................................................................................................ 185
UpdateConditionalForwarder.................................................................................................... 186
Request Syntax.............................................................................................................. 186
Request Parameters........................................................................................................ 186
Response Elements......................................................................................................... 186
Errors............................................................................................................................ 186
Examples....................................................................................................................... 187
See Also........................................................................................................................ 188
UpdateDirectorySetup............................................................................................................. 189
Request Syntax.............................................................................................................. 189
Request Parameters........................................................................................................ 189
Response Elements......................................................................................................... 189
Errors............................................................................................................................ 190
See Also........................................................................................................................ 190
UpdateNumberOfDomainControllers......................................................................................... 192
Request Syntax.............................................................................................................. 192
Request Parameters........................................................................................................ 192
Response Elements......................................................................................................... 192
Errors............................................................................................................................ 192
See Also........................................................................................................................ 193
UpdateRadius......................................................................................................................... 194
Request Syntax.............................................................................................................. 194
Request Parameters........................................................................................................ 194
x