aws-sdk-directoryservice 1.49.0 → 1.51.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.
@@ -1503,7 +1503,7 @@ module Aws::DirectoryService
1503
1503
  #
1504
1504
  # {
1505
1505
  # directory_id: "DirectoryId", # required
1506
- # type: "SmartCard", # accepts SmartCard
1506
+ # type: "SmartCard", # accepts SmartCard, SmartCardOrPassword
1507
1507
  # next_token: "NextToken",
1508
1508
  # limit: 1,
1509
1509
  # }
@@ -1893,6 +1893,68 @@ module Aws::DirectoryService
1893
1893
  include Aws::Structure
1894
1894
  end
1895
1895
 
1896
+ # @note When making an API call, you may pass DescribeSettingsRequest
1897
+ # data as a hash:
1898
+ #
1899
+ # {
1900
+ # directory_id: "DirectoryId", # required
1901
+ # status: "Requested", # accepts Requested, Updating, Updated, Failed, Default
1902
+ # next_token: "NextToken",
1903
+ # }
1904
+ #
1905
+ # @!attribute [rw] directory_id
1906
+ # The identifier of the directory for which to retrieve information.
1907
+ # @return [String]
1908
+ #
1909
+ # @!attribute [rw] status
1910
+ # The status of the directory settings for which to retrieve
1911
+ # information.
1912
+ # @return [String]
1913
+ #
1914
+ # @!attribute [rw] next_token
1915
+ # The `DescribeSettingsResult.NextToken` value from a previous call to
1916
+ # DescribeSettings. Pass null if this is the first call.
1917
+ # @return [String]
1918
+ #
1919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeSettingsRequest AWS API Documentation
1920
+ #
1921
+ class DescribeSettingsRequest < Struct.new(
1922
+ :directory_id,
1923
+ :status,
1924
+ :next_token)
1925
+ SENSITIVE = []
1926
+ include Aws::Structure
1927
+ end
1928
+
1929
+ # @!attribute [rw] directory_id
1930
+ # The identifier of the directory.
1931
+ # @return [String]
1932
+ #
1933
+ # @!attribute [rw] setting_entries
1934
+ # The list of SettingEntry objects that were retrieved.
1935
+ #
1936
+ # It is possible that this list contains less than the number of items
1937
+ # specified in the `Limit` member of the request. This occurs if there
1938
+ # are less than the requested number of items left to retrieve, or if
1939
+ # the limitations of the operation have been exceeded.
1940
+ # @return [Array<Types::SettingEntry>]
1941
+ #
1942
+ # @!attribute [rw] next_token
1943
+ # If not null, token that indicates that more results are available.
1944
+ # Pass this value for the `NextToken` parameter in a subsequent call
1945
+ # to `DescribeSettings` to retrieve the next set of items.
1946
+ # @return [String]
1947
+ #
1948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeSettingsResult AWS API Documentation
1949
+ #
1950
+ class DescribeSettingsResult < Struct.new(
1951
+ :directory_id,
1952
+ :setting_entries,
1953
+ :next_token)
1954
+ SENSITIVE = []
1955
+ include Aws::Structure
1956
+ end
1957
+
1896
1958
  # @note When making an API call, you may pass DescribeSharedDirectoriesRequest
1897
1959
  # data as a hash:
1898
1960
  #
@@ -2094,6 +2156,64 @@ module Aws::DirectoryService
2094
2156
  include Aws::Structure
2095
2157
  end
2096
2158
 
2159
+ # @note When making an API call, you may pass DescribeUpdateDirectoryRequest
2160
+ # data as a hash:
2161
+ #
2162
+ # {
2163
+ # directory_id: "DirectoryId", # required
2164
+ # update_type: "OS", # required, accepts OS
2165
+ # region_name: "RegionName",
2166
+ # next_token: "NextToken",
2167
+ # }
2168
+ #
2169
+ # @!attribute [rw] directory_id
2170
+ # The unique identifier of the directory.
2171
+ # @return [String]
2172
+ #
2173
+ # @!attribute [rw] update_type
2174
+ # The type of updates you want to describe for the directory.
2175
+ # @return [String]
2176
+ #
2177
+ # @!attribute [rw] region_name
2178
+ # The name of the Region.
2179
+ # @return [String]
2180
+ #
2181
+ # @!attribute [rw] next_token
2182
+ # The `DescribeUpdateDirectoryResult`. NextToken value from a previous
2183
+ # call to DescribeUpdateDirectory. Pass null if this is the first
2184
+ # call.
2185
+ # @return [String]
2186
+ #
2187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeUpdateDirectoryRequest AWS API Documentation
2188
+ #
2189
+ class DescribeUpdateDirectoryRequest < Struct.new(
2190
+ :directory_id,
2191
+ :update_type,
2192
+ :region_name,
2193
+ :next_token)
2194
+ SENSITIVE = []
2195
+ include Aws::Structure
2196
+ end
2197
+
2198
+ # @!attribute [rw] update_activities
2199
+ # The list of update activities on a directory for the requested
2200
+ # update type.
2201
+ # @return [Array<Types::UpdateInfoEntry>]
2202
+ #
2203
+ # @!attribute [rw] next_token
2204
+ # If not null, more results are available. Pass this value for the
2205
+ # `NextToken` parameter.
2206
+ # @return [String]
2207
+ #
2208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeUpdateDirectoryResult AWS API Documentation
2209
+ #
2210
+ class DescribeUpdateDirectoryResult < Struct.new(
2211
+ :update_activities,
2212
+ :next_token)
2213
+ SENSITIVE = []
2214
+ include Aws::Structure
2215
+ end
2216
+
2097
2217
  # The Region you specified is the same Region where the Managed
2098
2218
  # Microsoft AD directory was created. Specify a different Region and try
2099
2219
  # again.
@@ -2351,6 +2471,10 @@ module Aws::DirectoryService
2351
2471
  # Lists the Regions where the directory has replicated.
2352
2472
  # @return [Types::RegionsInfo]
2353
2473
  #
2474
+ # @!attribute [rw] os_version
2475
+ # The operating system (OS) version of the directory.
2476
+ # @return [String]
2477
+ #
2354
2478
  # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DirectoryDescription AWS API Documentation
2355
2479
  #
2356
2480
  class DirectoryDescription < Struct.new(
@@ -2378,7 +2502,8 @@ module Aws::DirectoryService
2378
2502
  :sso_enabled,
2379
2503
  :desired_number_of_domain_controllers,
2380
2504
  :owner_directory_description,
2381
- :regions_info)
2505
+ :regions_info,
2506
+ :os_version)
2382
2507
  SENSITIVE = [:share_notes]
2383
2508
  include Aws::Structure
2384
2509
  end
@@ -2402,6 +2527,25 @@ module Aws::DirectoryService
2402
2527
  include Aws::Structure
2403
2528
  end
2404
2529
 
2530
+ # The directory is already updated to desired update type settings.
2531
+ #
2532
+ # @!attribute [rw] message
2533
+ # The descriptive message for the exception.
2534
+ # @return [String]
2535
+ #
2536
+ # @!attribute [rw] request_id
2537
+ # The Amazon Web Services request identifier.
2538
+ # @return [String]
2539
+ #
2540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DirectoryInDesiredStateException AWS API Documentation
2541
+ #
2542
+ class DirectoryInDesiredStateException < Struct.new(
2543
+ :message,
2544
+ :request_id)
2545
+ SENSITIVE = []
2546
+ include Aws::Structure
2547
+ end
2548
+
2405
2549
  # The maximum number of directories in the region has been reached. You
2406
2550
  # can use the GetDirectoryLimits operation to determine your directory
2407
2551
  # limits in the region.
@@ -2584,7 +2728,7 @@ module Aws::DirectoryService
2584
2728
  #
2585
2729
  # {
2586
2730
  # directory_id: "DirectoryId", # required
2587
- # type: "SmartCard", # required, accepts SmartCard
2731
+ # type: "SmartCard", # required, accepts SmartCard, SmartCardOrPassword
2588
2732
  # }
2589
2733
  #
2590
2734
  # @!attribute [rw] directory_id
@@ -2802,7 +2946,7 @@ module Aws::DirectoryService
2802
2946
  #
2803
2947
  # {
2804
2948
  # directory_id: "DirectoryId", # required
2805
- # type: "SmartCard", # required, accepts SmartCard
2949
+ # type: "SmartCard", # required, accepts SmartCard, SmartCardOrPassword
2806
2950
  # }
2807
2951
  #
2808
2952
  # @!attribute [rw] directory_id
@@ -3086,6 +3230,25 @@ module Aws::DirectoryService
3086
3230
  include Aws::Structure
3087
3231
  end
3088
3232
 
3233
+ # The specified directory setting is not compatible with other settings.
3234
+ #
3235
+ # @!attribute [rw] message
3236
+ # The descriptive message for the exception.
3237
+ # @return [String]
3238
+ #
3239
+ # @!attribute [rw] request_id
3240
+ # The Amazon Web Services request identifier.
3241
+ # @return [String]
3242
+ #
3243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/IncompatibleSettingsException AWS API Documentation
3244
+ #
3245
+ class IncompatibleSettingsException < Struct.new(
3246
+ :message,
3247
+ :request_id)
3248
+ SENSITIVE = []
3249
+ include Aws::Structure
3250
+ end
3251
+
3089
3252
  # The account does not have sufficient permission to perform the
3090
3253
  # operation.
3091
3254
  #
@@ -3663,6 +3826,27 @@ module Aws::DirectoryService
3663
3826
  include Aws::Structure
3664
3827
  end
3665
3828
 
3829
+ # OS version that the directory needs to be updated to.
3830
+ #
3831
+ # @note When making an API call, you may pass OSUpdateSettings
3832
+ # data as a hash:
3833
+ #
3834
+ # {
3835
+ # os_version: "SERVER_2012", # accepts SERVER_2012, SERVER_2019
3836
+ # }
3837
+ #
3838
+ # @!attribute [rw] os_version
3839
+ # OS version that the directory needs to be updated to.
3840
+ # @return [String]
3841
+ #
3842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/OSUpdateSettings AWS API Documentation
3843
+ #
3844
+ class OSUpdateSettings < Struct.new(
3845
+ :os_version)
3846
+ SENSITIVE = []
3847
+ include Aws::Structure
3848
+ end
3849
+
3666
3850
  # Exception encountered while trying to access your Amazon Web Services
3667
3851
  # organization.
3668
3852
  #
@@ -4230,6 +4414,106 @@ module Aws::DirectoryService
4230
4414
  include Aws::Structure
4231
4415
  end
4232
4416
 
4417
+ # Contains information about the configurable settings for a directory.
4418
+ #
4419
+ # @note When making an API call, you may pass Setting
4420
+ # data as a hash:
4421
+ #
4422
+ # {
4423
+ # name: "DirectoryConfigurationSettingName", # required
4424
+ # value: "DirectoryConfigurationSettingValue", # required
4425
+ # }
4426
+ #
4427
+ # @!attribute [rw] name
4428
+ # The name of the directory setting. For example:
4429
+ #
4430
+ # `TLS_1_0`
4431
+ # @return [String]
4432
+ #
4433
+ # @!attribute [rw] value
4434
+ # The value of the directory setting for which to retrieve
4435
+ # information. For example, for `TLS_1_0`, the valid values are:
4436
+ # `Enable` and `Disable`.
4437
+ # @return [String]
4438
+ #
4439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/Setting AWS API Documentation
4440
+ #
4441
+ class Setting < Struct.new(
4442
+ :name,
4443
+ :value)
4444
+ SENSITIVE = []
4445
+ include Aws::Structure
4446
+ end
4447
+
4448
+ # Contains information about the specified configurable setting for a
4449
+ # directory.
4450
+ #
4451
+ # @!attribute [rw] type
4452
+ # The type of directory setting. For example, `Protocol` or `Cipher`.
4453
+ # @return [String]
4454
+ #
4455
+ # @!attribute [rw] name
4456
+ # The name of the directory setting. For example:
4457
+ #
4458
+ # `TLS_1_0`
4459
+ # @return [String]
4460
+ #
4461
+ # @!attribute [rw] allowed_values
4462
+ # The valid range of values for the directory setting.
4463
+ # @return [String]
4464
+ #
4465
+ # @!attribute [rw] applied_value
4466
+ # The value of the directory setting that is applied to the directory.
4467
+ # @return [String]
4468
+ #
4469
+ # @!attribute [rw] requested_value
4470
+ # The value that was last requested for the directory setting.
4471
+ # @return [String]
4472
+ #
4473
+ # @!attribute [rw] request_status
4474
+ # The overall status of the request to update the directory setting
4475
+ # request. If the directory setting is deployed in more than one
4476
+ # region, and the request fails in any region, the overall status is
4477
+ # `Failed`.
4478
+ # @return [String]
4479
+ #
4480
+ # @!attribute [rw] request_detailed_status
4481
+ # Details about the status of the request to update the directory
4482
+ # setting. If the directory setting is deployed in more than one
4483
+ # region, status is returned for the request in each region where the
4484
+ # setting is deployed.
4485
+ # @return [Hash<String,String>]
4486
+ #
4487
+ # @!attribute [rw] request_status_message
4488
+ # The last status message for the directory status request.
4489
+ # @return [String]
4490
+ #
4491
+ # @!attribute [rw] last_updated_date_time
4492
+ # The date and time when the directory setting was last updated.
4493
+ # @return [Time]
4494
+ #
4495
+ # @!attribute [rw] last_requested_date_time
4496
+ # The date and time when the request to update a directory setting was
4497
+ # last submitted.
4498
+ # @return [Time]
4499
+ #
4500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/SettingEntry AWS API Documentation
4501
+ #
4502
+ class SettingEntry < Struct.new(
4503
+ :type,
4504
+ :name,
4505
+ :allowed_values,
4506
+ :applied_value,
4507
+ :requested_value,
4508
+ :request_status,
4509
+ :request_detailed_status,
4510
+ :request_status_message,
4511
+ :last_updated_date_time,
4512
+ :last_requested_date_time)
4513
+ SENSITIVE = []
4514
+ include Aws::Structure
4515
+ end
4516
+
4233
4517
  # @note When making an API call, you may pass ShareDirectoryRequest
4234
4518
  # data as a hash:
4235
4519
  #
@@ -4755,6 +5039,25 @@ module Aws::DirectoryService
4755
5039
  include Aws::Structure
4756
5040
  end
4757
5041
 
5042
+ # The specified directory setting is not supported.
5043
+ #
5044
+ # @!attribute [rw] message
5045
+ # The descriptive message for the exception.
5046
+ # @return [String]
5047
+ #
5048
+ # @!attribute [rw] request_id
5049
+ # The Amazon Web Services request identifier.
5050
+ # @return [String]
5051
+ #
5052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UnsupportedSettingsException AWS API Documentation
5053
+ #
5054
+ class UnsupportedSettingsException < Struct.new(
5055
+ :message,
5056
+ :request_id)
5057
+ SENSITIVE = []
5058
+ include Aws::Structure
5059
+ end
5060
+
4758
5061
  # Updates a conditional forwarder.
4759
5062
  #
4760
5063
  # @note When making an API call, you may pass UpdateConditionalForwarderRequest
@@ -4797,6 +5100,104 @@ module Aws::DirectoryService
4797
5100
  #
4798
5101
  class UpdateConditionalForwarderResult < Aws::EmptyStructure; end
4799
5102
 
5103
+ # @note When making an API call, you may pass UpdateDirectorySetupRequest
5104
+ # data as a hash:
5105
+ #
5106
+ # {
5107
+ # directory_id: "DirectoryId", # required
5108
+ # update_type: "OS", # required, accepts OS
5109
+ # os_update_settings: {
5110
+ # os_version: "SERVER_2012", # accepts SERVER_2012, SERVER_2019
5111
+ # },
5112
+ # create_snapshot_before_update: false,
5113
+ # }
5114
+ #
5115
+ # @!attribute [rw] directory_id
5116
+ # The identifier of the directory on which you want to perform the
5117
+ # update.
5118
+ # @return [String]
5119
+ #
5120
+ # @!attribute [rw] update_type
5121
+ # The type of update that needs to be performed on the directory. For
5122
+ # example, OS.
5123
+ # @return [String]
5124
+ #
5125
+ # @!attribute [rw] os_update_settings
5126
+ # The settings for the OS update that needs to be performed on the
5127
+ # directory.
5128
+ # @return [Types::OSUpdateSettings]
5129
+ #
5130
+ # @!attribute [rw] create_snapshot_before_update
5131
+ # The boolean that specifies if a snapshot for the directory needs to
5132
+ # be taken before updating the directory.
5133
+ # @return [Boolean]
5134
+ #
5135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateDirectorySetupRequest AWS API Documentation
5136
+ #
5137
+ class UpdateDirectorySetupRequest < Struct.new(
5138
+ :directory_id,
5139
+ :update_type,
5140
+ :os_update_settings,
5141
+ :create_snapshot_before_update)
5142
+ SENSITIVE = []
5143
+ include Aws::Structure
5144
+ end
5145
+
5146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateDirectorySetupResult AWS API Documentation
5147
+ #
5148
+ class UpdateDirectorySetupResult < Aws::EmptyStructure; end
5149
+
5150
+ # An entry of update information related to a requested update type.
5151
+ #
5152
+ # @!attribute [rw] region
5153
+ # The name of the Region.
5154
+ # @return [String]
5155
+ #
5156
+ # @!attribute [rw] status
5157
+ # The status of the update performed on the directory.
5158
+ # @return [String]
5159
+ #
5160
+ # @!attribute [rw] status_reason
5161
+ # The reason for the current status of the update type activity.
5162
+ # @return [String]
5163
+ #
5164
+ # @!attribute [rw] initiated_by
5165
+ # This specifies if the update was initiated by the customer or by the
5166
+ # service team.
5167
+ # @return [String]
5168
+ #
5169
+ # @!attribute [rw] new_value
5170
+ # The new value of the target setting.
5171
+ # @return [Types::UpdateValue]
5172
+ #
5173
+ # @!attribute [rw] previous_value
5174
+ # The old value of the target setting.
5175
+ # @return [Types::UpdateValue]
5176
+ #
5177
+ # @!attribute [rw] start_time
5178
+ # The start time of the `UpdateDirectorySetup` for the particular
5179
+ # type.
5180
+ # @return [Time]
5181
+ #
5182
+ # @!attribute [rw] last_updated_date_time
5183
+ # The last updated date and time of a particular directory setting.
5184
+ # @return [Time]
5185
+ #
5186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateInfoEntry AWS API Documentation
5187
+ #
5188
+ class UpdateInfoEntry < Struct.new(
5189
+ :region,
5190
+ :status,
5191
+ :status_reason,
5192
+ :initiated_by,
5193
+ :new_value,
5194
+ :previous_value,
5195
+ :start_time,
5196
+ :last_updated_date_time)
5197
+ SENSITIVE = []
5198
+ include Aws::Structure
5199
+ end
5200
+
4800
5201
  # @note When making an API call, you may pass UpdateNumberOfDomainControllersRequest
4801
5202
  # data as a hash:
4802
5203
  #
@@ -4871,6 +5272,48 @@ module Aws::DirectoryService
4871
5272
  #
4872
5273
  class UpdateRadiusResult < Aws::EmptyStructure; end
4873
5274
 
5275
+ # @note When making an API call, you may pass UpdateSettingsRequest
5276
+ # data as a hash:
5277
+ #
5278
+ # {
5279
+ # directory_id: "DirectoryId", # required
5280
+ # settings: [ # required
5281
+ # {
5282
+ # name: "DirectoryConfigurationSettingName", # required
5283
+ # value: "DirectoryConfigurationSettingValue", # required
5284
+ # },
5285
+ # ],
5286
+ # }
5287
+ #
5288
+ # @!attribute [rw] directory_id
5289
+ # The identifier of the directory for which to update settings.
5290
+ # @return [String]
5291
+ #
5292
+ # @!attribute [rw] settings
5293
+ # The list of Setting objects.
5294
+ # @return [Array<Types::Setting>]
5295
+ #
5296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateSettingsRequest AWS API Documentation
5297
+ #
5298
+ class UpdateSettingsRequest < Struct.new(
5299
+ :directory_id,
5300
+ :settings)
5301
+ SENSITIVE = []
5302
+ include Aws::Structure
5303
+ end
5304
+
5305
+ # @!attribute [rw] directory_id
5306
+ # The identifier of the directory.
5307
+ # @return [String]
5308
+ #
5309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateSettingsResult AWS API Documentation
5310
+ #
5311
+ class UpdateSettingsResult < Struct.new(
5312
+ :directory_id)
5313
+ SENSITIVE = []
5314
+ include Aws::Structure
5315
+ end
5316
+
4874
5317
  # @note When making an API call, you may pass UpdateTrustRequest
4875
5318
  # data as a hash:
4876
5319
  #
@@ -4913,6 +5356,20 @@ module Aws::DirectoryService
4913
5356
  include Aws::Structure
4914
5357
  end
4915
5358
 
5359
+ # The value for a given type of `UpdateSettings`.
5360
+ #
5361
+ # @!attribute [rw] os_update_settings
5362
+ # The OS update related settings.
5363
+ # @return [Types::OSUpdateSettings]
5364
+ #
5365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateValue AWS API Documentation
5366
+ #
5367
+ class UpdateValue < Struct.new(
5368
+ :os_update_settings)
5369
+ SENSITIVE = []
5370
+ include Aws::Structure
5371
+ end
5372
+
4916
5373
  # The user provided a username that does not exist in your directory.
4917
5374
  #
4918
5375
  # @!attribute [rw] message
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-directoryservice/customizations'
48
48
  # @!group service
49
49
  module Aws::DirectoryService
50
50
 
51
- GEM_VERSION = '1.49.0'
51
+ GEM_VERSION = '1.51.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-directoryservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.49.0
4
+ version: 1.51.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-02-24 00:00:00.000000000 Z
11
+ date: 2022-10-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core