aws-sdk-opensearchservice 1.15.0 → 1.17.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.
@@ -63,8 +63,8 @@ module Aws::OpenSearchService
63
63
  include Aws::Structure
64
64
  end
65
65
 
66
- # An error occurred because user does not have permissions to access the
67
- # resource. Returns HTTP status code 403.
66
+ # An error occurred because you don't have permissions to access the
67
+ # resource.
68
68
  #
69
69
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AccessDeniedException AWS API Documentation
70
70
  #
@@ -439,12 +439,20 @@ module Aws::OpenSearchService
439
439
  include Aws::Structure
440
440
  end
441
441
 
442
+ # <note markdown="1"> This object is deprecated. Use the domain's [off-peak window][1] to
443
+ # schedule Auto-Tune optimizations. For migration instructions, see
444
+ # [Migrating from Auto-Tune maintenance windows][2].
445
+ #
446
+ # </note>
447
+ #
442
448
  # The Auto-Tune maintenance schedule. For more information, see
443
- # [Auto-Tune for Amazon OpenSearch Service][1].
449
+ # [Auto-Tune for Amazon OpenSearch Service][3].
444
450
  #
445
451
  #
446
452
  #
447
- # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
453
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
454
+ # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate
455
+ # [3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
448
456
  #
449
457
  # @!attribute [rw] start_at
450
458
  # The Epoch timestamp at which the Auto-Tune maintenance schedule
@@ -491,22 +499,39 @@ module Aws::OpenSearchService
491
499
  # @return [String]
492
500
  #
493
501
  # @!attribute [rw] maintenance_schedules
502
+ # DEPRECATED. Use [off-peak window][1] instead.
503
+ #
494
504
  # A list of maintenance schedules during which Auto-Tune can deploy
495
505
  # changes.
506
+ #
507
+ #
508
+ #
509
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
496
510
  # @return [Array<Types::AutoTuneMaintenanceSchedule>]
497
511
  #
512
+ # @!attribute [rw] use_off_peak_window
513
+ # Whether to use the domain's [off-peak window][1] to deploy
514
+ # configuration changes on the domain rather than a maintenance
515
+ # schedule.
516
+ #
517
+ #
518
+ #
519
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
520
+ # @return [Boolean]
521
+ #
498
522
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptions AWS API Documentation
499
523
  #
500
524
  class AutoTuneOptions < Struct.new(
501
525
  :desired_state,
502
526
  :rollback_on_disable,
503
- :maintenance_schedules)
527
+ :maintenance_schedules,
528
+ :use_off_peak_window)
504
529
  SENSITIVE = []
505
530
  include Aws::Structure
506
531
  end
507
532
 
508
533
  # Options for configuring Auto-Tune. For more information, see
509
- # [Auto-Tune for Amazon OpenSearch Service][1].
534
+ # [Auto-Tune for Amazon OpenSearch Service][1]
510
535
  #
511
536
  #
512
537
  #
@@ -518,18 +543,25 @@ module Aws::OpenSearchService
518
543
  #
519
544
  # @!attribute [rw] maintenance_schedules
520
545
  # A list of maintenance schedules during which Auto-Tune can deploy
521
- # changes. Maintenance schedules are overwrite, not append. If your
522
- # request includes no schedules, the request deletes all existing
523
- # schedules. To preserve existing schedules, make a call to
524
- # `DescribeDomainConfig` first and use the `MaintenanceSchedules`
525
- # portion of the response as the basis for this section.
546
+ # changes. Maintenance windows are deprecated and have been replaced
547
+ # with [off-peak windows][1].
548
+ #
549
+ #
550
+ #
551
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
526
552
  # @return [Array<Types::AutoTuneMaintenanceSchedule>]
527
553
  #
554
+ # @!attribute [rw] use_off_peak_window
555
+ # Whether to schedule Auto-Tune optimizations that require blue/green
556
+ # deployments during the domain's configured daily off-peak window.
557
+ # @return [Boolean]
558
+ #
528
559
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsInput AWS API Documentation
529
560
  #
530
561
  class AutoTuneOptionsInput < Struct.new(
531
562
  :desired_state,
532
- :maintenance_schedules)
563
+ :maintenance_schedules,
564
+ :use_off_peak_window)
533
565
  SENSITIVE = []
534
566
  include Aws::Structure
535
567
  end
@@ -545,11 +577,17 @@ module Aws::OpenSearchService
545
577
  # Any errors that occurred while enabling or disabling Auto-Tune.
546
578
  # @return [String]
547
579
  #
580
+ # @!attribute [rw] use_off_peak_window
581
+ # Whether the domain's off-peak window will be used to deploy
582
+ # Auto-Tune changes rather than a maintenance schedule.
583
+ # @return [Boolean]
584
+ #
548
585
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsOutput AWS API Documentation
549
586
  #
550
587
  class AutoTuneOptionsOutput < Struct.new(
551
588
  :state,
552
- :error_message)
589
+ :error_message,
590
+ :use_off_peak_window)
553
591
  SENSITIVE = []
554
592
  include Aws::Structure
555
593
  end
@@ -963,12 +1001,26 @@ module Aws::OpenSearchService
963
1001
  end
964
1002
 
965
1003
  # An error occurred because the client attempts to remove a resource
966
- # that is currently in use. Returns HTTP status code 409.
1004
+ # that is currently in use.
967
1005
  #
968
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ConflictException AWS API Documentation
969
1007
  #
970
1008
  class ConflictException < Aws::EmptyStructure; end
971
1009
 
1010
+ # The connection properties of an outbound connection.
1011
+ #
1012
+ # @!attribute [rw] endpoint
1013
+ # The endpoint of the remote domain.
1014
+ # @return [String]
1015
+ #
1016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ConnectionProperties AWS API Documentation
1017
+ #
1018
+ class ConnectionProperties < Struct.new(
1019
+ :endpoint)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
972
1024
  # @!attribute [rw] domain_name
973
1025
  # Name of the OpenSearch Service domain to create. Domain names are
974
1026
  # unique across the domains owned by an account within an Amazon Web
@@ -1089,6 +1141,19 @@ module Aws::OpenSearchService
1089
1141
  # Options for Auto-Tune.
1090
1142
  # @return [Types::AutoTuneOptionsInput]
1091
1143
  #
1144
+ # @!attribute [rw] off_peak_window_options
1145
+ # Specifies a daily 10-hour time block during which OpenSearch Service
1146
+ # can perform configuration changes on the domain, including service
1147
+ # software updates and Auto-Tune enhancements that require a
1148
+ # blue/green deployment. If no options are specified, the default
1149
+ # start time of 10:00 P.M. local time (for the Region that the domain
1150
+ # is created in) is used.
1151
+ # @return [Types::OffPeakWindowOptions]
1152
+ #
1153
+ # @!attribute [rw] software_update_options
1154
+ # Software update options for the domain.
1155
+ # @return [Types::SoftwareUpdateOptions]
1156
+ #
1092
1157
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomainRequest AWS API Documentation
1093
1158
  #
1094
1159
  class CreateDomainRequest < Struct.new(
@@ -1107,7 +1172,9 @@ module Aws::OpenSearchService
1107
1172
  :domain_endpoint_options,
1108
1173
  :advanced_security_options,
1109
1174
  :tag_list,
1110
- :auto_tune_options)
1175
+ :auto_tune_options,
1176
+ :off_peak_window_options,
1177
+ :software_update_options)
1111
1178
  SENSITIVE = []
1112
1179
  include Aws::Structure
1113
1180
  end
@@ -1142,12 +1209,17 @@ module Aws::OpenSearchService
1142
1209
  # Name of the connection.
1143
1210
  # @return [String]
1144
1211
  #
1212
+ # @!attribute [rw] connection_mode
1213
+ # The connection mode.
1214
+ # @return [String]
1215
+ #
1145
1216
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnectionRequest AWS API Documentation
1146
1217
  #
1147
1218
  class CreateOutboundConnectionRequest < Struct.new(
1148
1219
  :local_domain_info,
1149
1220
  :remote_domain_info,
1150
- :connection_alias)
1221
+ :connection_alias,
1222
+ :connection_mode)
1151
1223
  SENSITIVE = []
1152
1224
  include Aws::Structure
1153
1225
  end
@@ -1176,6 +1248,14 @@ module Aws::OpenSearchService
1176
1248
  # used for subsequent operations on the connection.
1177
1249
  # @return [String]
1178
1250
  #
1251
+ # @!attribute [rw] connection_mode
1252
+ # The connection mode.
1253
+ # @return [String]
1254
+ #
1255
+ # @!attribute [rw] connection_properties
1256
+ # The `ConnectionProperties` for the newly created connection.
1257
+ # @return [Types::ConnectionProperties]
1258
+ #
1179
1259
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnectionResponse AWS API Documentation
1180
1260
  #
1181
1261
  class CreateOutboundConnectionResponse < Struct.new(
@@ -1183,7 +1263,9 @@ module Aws::OpenSearchService
1183
1263
  :remote_domain_info,
1184
1264
  :connection_alias,
1185
1265
  :connection_status,
1186
- :connection_id)
1266
+ :connection_id,
1267
+ :connection_mode,
1268
+ :connection_properties)
1187
1269
  SENSITIVE = []
1188
1270
  include Aws::Structure
1189
1271
  end
@@ -1994,7 +2076,7 @@ module Aws::OpenSearchService
1994
2076
  end
1995
2077
 
1996
2078
  # An error occured because the client wanted to access a not supported
1997
- # operation. Gives http status code of 409.
2079
+ # operation.
1998
2080
  #
1999
2081
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DisabledOperationException AWS API Documentation
2000
2082
  #
@@ -2048,8 +2130,7 @@ module Aws::OpenSearchService
2048
2130
  # @return [Types::ClusterConfigStatus]
2049
2131
  #
2050
2132
  # @!attribute [rw] ebs_options
2051
- # Container for EBS options configured for an OpenSearch Service
2052
- # domain.
2133
+ # Container for EBS options configured for the domain.
2053
2134
  # @return [Types::EBSOptionsStatus]
2054
2135
  #
2055
2136
  # @!attribute [rw] access_policies
@@ -2109,6 +2190,14 @@ module Aws::OpenSearchService
2109
2190
  # configuration change.
2110
2191
  # @return [Types::ChangeProgressDetails]
2111
2192
  #
2193
+ # @!attribute [rw] off_peak_window_options
2194
+ # Container for off-peak window options for the domain.
2195
+ # @return [Types::OffPeakWindowOptionsStatus]
2196
+ #
2197
+ # @!attribute [rw] software_update_options
2198
+ # Software update options for the domain.
2199
+ # @return [Types::SoftwareUpdateOptionsStatus]
2200
+ #
2112
2201
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainConfig AWS API Documentation
2113
2202
  #
2114
2203
  class DomainConfig < Struct.new(
@@ -2126,7 +2215,9 @@ module Aws::OpenSearchService
2126
2215
  :domain_endpoint_options,
2127
2216
  :advanced_security_options,
2128
2217
  :auto_tune_options,
2129
- :change_progress_details)
2218
+ :change_progress_details,
2219
+ :off_peak_window_options,
2220
+ :software_update_options)
2130
2221
  SENSITIVE = []
2131
2222
  include Aws::Structure
2132
2223
  end
@@ -2418,6 +2509,15 @@ module Aws::OpenSearchService
2418
2509
  # Information about a configuration change happening on the domain.
2419
2510
  # @return [Types::ChangeProgressDetails]
2420
2511
  #
2512
+ # @!attribute [rw] off_peak_window_options
2513
+ # Options that specify a custom 10-hour window during which OpenSearch
2514
+ # Service can perform configuration changes on the domain.
2515
+ # @return [Types::OffPeakWindowOptions]
2516
+ #
2517
+ # @!attribute [rw] software_update_options
2518
+ # Service software update options for the domain.
2519
+ # @return [Types::SoftwareUpdateOptions]
2520
+ #
2421
2521
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainStatus AWS API Documentation
2422
2522
  #
2423
2523
  class DomainStatus < Struct.new(
@@ -2445,7 +2545,9 @@ module Aws::OpenSearchService
2445
2545
  :domain_endpoint_options,
2446
2546
  :advanced_security_options,
2447
2547
  :auto_tune_options,
2448
- :change_progress_details)
2548
+ :change_progress_details,
2549
+ :off_peak_window_options,
2550
+ :software_update_options)
2449
2551
  SENSITIVE = []
2450
2552
  include Aws::Structure
2451
2553
  end
@@ -2890,13 +2992,18 @@ module Aws::OpenSearchService
2890
2992
  # The current status of the connection.
2891
2993
  # @return [Types::InboundConnectionStatus]
2892
2994
  #
2995
+ # @!attribute [rw] connection_mode
2996
+ # The connection mode.
2997
+ # @return [String]
2998
+ #
2893
2999
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InboundConnection AWS API Documentation
2894
3000
  #
2895
3001
  class InboundConnection < Struct.new(
2896
3002
  :local_domain_info,
2897
3003
  :remote_domain_info,
2898
3004
  :connection_id,
2899
- :connection_status)
3005
+ :connection_status,
3006
+ :connection_mode)
2900
3007
  SENSITIVE = []
2901
3008
  include Aws::Structure
2902
3009
  end
@@ -3024,30 +3131,29 @@ module Aws::OpenSearchService
3024
3131
  include Aws::Structure
3025
3132
  end
3026
3133
 
3027
- # The request processing has failed because of an unknown error,
3028
- # exception or failure (the failure is internal to the service) . Gives
3029
- # http status code of 500.
3134
+ # Request processing failed because of an unknown error, exception, or
3135
+ # internal failure.
3030
3136
  #
3031
3137
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InternalException AWS API Documentation
3032
3138
  #
3033
3139
  class InternalException < Aws::EmptyStructure; end
3034
3140
 
3035
- # The request processing has failed because of invalid pagination token
3036
- # provided by customer. Returns an HTTP status code of 400.
3141
+ # The request processing has failed because you provided an invalid
3142
+ # pagination token.
3037
3143
  #
3038
3144
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidPaginationTokenException AWS API Documentation
3039
3145
  #
3040
3146
  class InvalidPaginationTokenException < Aws::EmptyStructure; end
3041
3147
 
3042
- # An exception for trying to create or access sub-resource that is
3043
- # either invalid or not supported. Gives http status code of 409.
3148
+ # An exception for trying to create or access a sub-resource that's
3149
+ # either invalid or not supported.
3044
3150
  #
3045
3151
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidTypeException AWS API Documentation
3046
3152
  #
3047
3153
  class InvalidTypeException < Aws::EmptyStructure; end
3048
3154
 
3049
- # An exception for trying to create more than allowed resources or
3050
- # sub-resources. Gives http status code of 409.
3155
+ # An exception for trying to create more than the allowed number of
3156
+ # resources or sub-resources.
3051
3157
  #
3052
3158
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/LimitExceededException AWS API Documentation
3053
3159
  #
@@ -3269,6 +3375,52 @@ module Aws::OpenSearchService
3269
3375
  include Aws::Structure
3270
3376
  end
3271
3377
 
3378
+ # @!attribute [rw] domain_name
3379
+ # The name of the domain.
3380
+ # @return [String]
3381
+ #
3382
+ # @!attribute [rw] max_results
3383
+ # An optional parameter that specifies the maximum number of results
3384
+ # to return. You can use `nextToken` to get the next page of results.
3385
+ # @return [Integer]
3386
+ #
3387
+ # @!attribute [rw] next_token
3388
+ # If your initial `ListScheduledActions` operation returns a
3389
+ # `nextToken`, you can include the returned `nextToken` in subsequent
3390
+ # `ListScheduledActions` operations, which returns results in the next
3391
+ # page.
3392
+ # @return [String]
3393
+ #
3394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsRequest AWS API Documentation
3395
+ #
3396
+ class ListScheduledActionsRequest < Struct.new(
3397
+ :domain_name,
3398
+ :max_results,
3399
+ :next_token)
3400
+ SENSITIVE = []
3401
+ include Aws::Structure
3402
+ end
3403
+
3404
+ # @!attribute [rw] scheduled_actions
3405
+ # A list of actions that are scheduled for the domain.
3406
+ # @return [Array<Types::ScheduledAction>]
3407
+ #
3408
+ # @!attribute [rw] next_token
3409
+ # When `nextToken` is returned, there are more results available. The
3410
+ # value of `nextToken` is a unique pagination token for each page.
3411
+ # Make the call again using the returned token to retrieve the next
3412
+ # page.
3413
+ # @return [String]
3414
+ #
3415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsResponse AWS API Documentation
3416
+ #
3417
+ class ListScheduledActionsResponse < Struct.new(
3418
+ :scheduled_actions,
3419
+ :next_token)
3420
+ SENSITIVE = []
3421
+ include Aws::Structure
3422
+ end
3423
+
3272
3424
  # Container for the parameters to the `ListTags` operation.
3273
3425
  #
3274
3426
  # @!attribute [rw] arn
@@ -3582,6 +3734,91 @@ module Aws::OpenSearchService
3582
3734
  include Aws::Structure
3583
3735
  end
3584
3736
 
3737
+ # A custom 10-hour, low-traffic window during which OpenSearch Service
3738
+ # can perform mandatory configuration changes on the domain. These
3739
+ # actions can include scheduled service software updates and blue/green
3740
+ # Auto-Tune enhancements. OpenSearch Service will schedule these actions
3741
+ # during the window that you specify.
3742
+ #
3743
+ # If you don't specify a window start time, it defaults to 10:00 P.M.
3744
+ # local time.
3745
+ #
3746
+ # For more information, see [Defining off-peak maintenance windows for
3747
+ # Amazon OpenSearch Service][1].
3748
+ #
3749
+ #
3750
+ #
3751
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
3752
+ #
3753
+ # @!attribute [rw] window_start_time
3754
+ # A custom start time for the off-peak window, in Coordinated
3755
+ # Universal Time (UTC). The window length will always be 10 hours, so
3756
+ # you can't specify an end time. For example, if you specify 11:00
3757
+ # P.M. UTC as a start time, the end time will automatically be set to
3758
+ # 9:00 A.M.
3759
+ # @return [Types::WindowStartTime]
3760
+ #
3761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindow AWS API Documentation
3762
+ #
3763
+ class OffPeakWindow < Struct.new(
3764
+ :window_start_time)
3765
+ SENSITIVE = []
3766
+ include Aws::Structure
3767
+ end
3768
+
3769
+ # Options for a domain's [off-peak window][1], during which OpenSearch
3770
+ # Service can perform mandatory configuration changes on the domain.
3771
+ #
3772
+ #
3773
+ #
3774
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
3775
+ #
3776
+ # @!attribute [rw] enabled
3777
+ # Whether to enable an off-peak window.
3778
+ #
3779
+ # This option is only available when modifying a domain created prior
3780
+ # to February 13, 2023, not when creating a new domain. All domains
3781
+ # created after this date have the off-peak window enabled by default.
3782
+ # You can't disable the off-peak window after it's enabled for a
3783
+ # domain.
3784
+ # @return [Boolean]
3785
+ #
3786
+ # @!attribute [rw] off_peak_window
3787
+ # Off-peak window settings for the domain.
3788
+ # @return [Types::OffPeakWindow]
3789
+ #
3790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptions AWS API Documentation
3791
+ #
3792
+ class OffPeakWindowOptions < Struct.new(
3793
+ :enabled,
3794
+ :off_peak_window)
3795
+ SENSITIVE = []
3796
+ include Aws::Structure
3797
+ end
3798
+
3799
+ # The status of [off-peak window][1] options for a domain.
3800
+ #
3801
+ #
3802
+ #
3803
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
3804
+ #
3805
+ # @!attribute [rw] options
3806
+ # The domain's off-peak window configuration.
3807
+ # @return [Types::OffPeakWindowOptions]
3808
+ #
3809
+ # @!attribute [rw] status
3810
+ # The current status of off-peak window options.
3811
+ # @return [Types::OptionStatus]
3812
+ #
3813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptionsStatus AWS API Documentation
3814
+ #
3815
+ class OffPeakWindowOptionsStatus < Struct.new(
3816
+ :options,
3817
+ :status)
3818
+ SENSITIVE = []
3819
+ include Aws::Structure
3820
+ end
3821
+
3585
3822
  # Provides the current status of an entity.
3586
3823
  #
3587
3824
  # @!attribute [rw] creation_date
@@ -3638,6 +3875,14 @@ module Aws::OpenSearchService
3638
3875
  # Status of the connection.
3639
3876
  # @return [Types::OutboundConnectionStatus]
3640
3877
  #
3878
+ # @!attribute [rw] connection_mode
3879
+ # The connection mode.
3880
+ # @return [String]
3881
+ #
3882
+ # @!attribute [rw] connection_properties
3883
+ # Properties for the outbound connection.
3884
+ # @return [Types::ConnectionProperties]
3885
+ #
3641
3886
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OutboundConnection AWS API Documentation
3642
3887
  #
3643
3888
  class OutboundConnection < Struct.new(
@@ -3645,7 +3890,9 @@ module Aws::OpenSearchService
3645
3890
  :remote_domain_info,
3646
3891
  :connection_id,
3647
3892
  :connection_alias,
3648
- :connection_status)
3893
+ :connection_status,
3894
+ :connection_mode,
3895
+ :connection_properties)
3649
3896
  SENSITIVE = []
3650
3897
  include Aws::Structure
3651
3898
  end
@@ -4047,15 +4294,14 @@ module Aws::OpenSearchService
4047
4294
  include Aws::Structure
4048
4295
  end
4049
4296
 
4050
- # An exception for creating a resource that already exists. Gives http
4051
- # status code of 400.
4297
+ # An exception for creating a resource that already exists.
4052
4298
  #
4053
4299
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ResourceAlreadyExistsException AWS API Documentation
4054
4300
  #
4055
4301
  class ResourceAlreadyExistsException < Aws::EmptyStructure; end
4056
4302
 
4057
- # An exception for accessing or deleting a resource that does not exist.
4058
- # Gives http status code of 400.
4303
+ # An exception for accessing or deleting a resource that does not
4304
+ # exist..
4059
4305
  #
4060
4306
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ResourceNotFoundException AWS API Documentation
4061
4307
  #
@@ -4187,6 +4433,68 @@ module Aws::OpenSearchService
4187
4433
  include Aws::Structure
4188
4434
  end
4189
4435
 
4436
+ # Information about a scheduled configuration change for an OpenSearch
4437
+ # Service domain. This actions can be a [service software update][1] or
4438
+ # a [blue/green Auto-Tune enhancement][2].
4439
+ #
4440
+ #
4441
+ #
4442
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
4443
+ # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
4444
+ #
4445
+ # @!attribute [rw] id
4446
+ # The unique identifier of the scheduled action.
4447
+ # @return [String]
4448
+ #
4449
+ # @!attribute [rw] type
4450
+ # The type of action that will be taken on the domain.
4451
+ # @return [String]
4452
+ #
4453
+ # @!attribute [rw] severity
4454
+ # The severity of the action.
4455
+ # @return [String]
4456
+ #
4457
+ # @!attribute [rw] scheduled_time
4458
+ # The time when the change is scheduled to happen.
4459
+ # @return [Integer]
4460
+ #
4461
+ # @!attribute [rw] description
4462
+ # A description of the action to be taken.
4463
+ # @return [String]
4464
+ #
4465
+ # @!attribute [rw] scheduled_by
4466
+ # Whether the action was scheduled manually (`CUSTOMER`, or by
4467
+ # OpenSearch Service automatically (`SYSTEM`).
4468
+ # @return [String]
4469
+ #
4470
+ # @!attribute [rw] status
4471
+ # The current status of the scheduled action.
4472
+ # @return [String]
4473
+ #
4474
+ # @!attribute [rw] mandatory
4475
+ # Whether the action is required or optional.
4476
+ # @return [Boolean]
4477
+ #
4478
+ # @!attribute [rw] cancellable
4479
+ # Whether or not the scheduled action is cancellable.
4480
+ # @return [Boolean]
4481
+ #
4482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ScheduledAction AWS API Documentation
4483
+ #
4484
+ class ScheduledAction < Struct.new(
4485
+ :id,
4486
+ :type,
4487
+ :severity,
4488
+ :scheduled_time,
4489
+ :description,
4490
+ :scheduled_by,
4491
+ :status,
4492
+ :mandatory,
4493
+ :cancellable)
4494
+ SENSITIVE = []
4495
+ include Aws::Structure
4496
+ end
4497
+
4190
4498
  # Specifies details about a scheduled Auto-Tune action. For more
4191
4499
  # information, see [Auto-Tune for Amazon OpenSearch Service][1].
4192
4500
  #
@@ -4284,6 +4592,22 @@ module Aws::OpenSearchService
4284
4592
  include Aws::Structure
4285
4593
  end
4286
4594
 
4595
+ # An exception for attempting to schedule a domain action during an
4596
+ # unavailable time slot.
4597
+ #
4598
+ # @!attribute [rw] slot_suggestions
4599
+ # Alternate time slots during which OpenSearch Service has available
4600
+ # capacity to schedule a domain action.
4601
+ # @return [Array<Integer>]
4602
+ #
4603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SlotNotAvailableException AWS API Documentation
4604
+ #
4605
+ class SlotNotAvailableException < Struct.new(
4606
+ :slot_suggestions)
4607
+ SENSITIVE = []
4608
+ include Aws::Structure
4609
+ end
4610
+
4287
4611
  # The time, in UTC format, when OpenSearch Service takes a daily
4288
4612
  # automated snapshot of the specified domain. Default is `0` hours.
4289
4613
  #
@@ -4320,6 +4644,41 @@ module Aws::OpenSearchService
4320
4644
  include Aws::Structure
4321
4645
  end
4322
4646
 
4647
+ # Options for configuring service software updates for a domain.
4648
+ #
4649
+ # @!attribute [rw] auto_software_update_enabled
4650
+ # Whether automatic service software updates are enabled for the
4651
+ # domain.
4652
+ # @return [Boolean]
4653
+ #
4654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptions AWS API Documentation
4655
+ #
4656
+ class SoftwareUpdateOptions < Struct.new(
4657
+ :auto_software_update_enabled)
4658
+ SENSITIVE = []
4659
+ include Aws::Structure
4660
+ end
4661
+
4662
+ # The status of the service software options for a domain.
4663
+ #
4664
+ # @!attribute [rw] options
4665
+ # The service software update options for a domain.
4666
+ # @return [Types::SoftwareUpdateOptions]
4667
+ #
4668
+ # @!attribute [rw] status
4669
+ # The status of service software update options, including creation
4670
+ # date and last updated date.
4671
+ # @return [Types::OptionStatus]
4672
+ #
4673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptionsStatus AWS API Documentation
4674
+ #
4675
+ class SoftwareUpdateOptionsStatus < Struct.new(
4676
+ :options,
4677
+ :status)
4678
+ SENSITIVE = []
4679
+ include Aws::Structure
4680
+ end
4681
+
4323
4682
  # Container for the request parameters to the
4324
4683
  # `StartServiceSoftwareUpdate` operation.
4325
4684
  #
@@ -4328,10 +4687,37 @@ module Aws::OpenSearchService
4328
4687
  # software.
4329
4688
  # @return [String]
4330
4689
  #
4690
+ # @!attribute [rw] schedule_at
4691
+ # When to start the service software update.
4692
+ #
4693
+ # * `NOW` - Immediately schedules the update to happen in the current
4694
+ # hour if there's capacity available.
4695
+ #
4696
+ # * `TIMESTAMP` - Lets you specify a custom date and time to apply the
4697
+ # update. If you specify this value, you must also provide a value
4698
+ # for `DesiredStartTime`.
4699
+ #
4700
+ # * `OFF_PEAK_WINDOW` - Marks the update to be picked up during an
4701
+ # upcoming off-peak window. There's no guarantee that the update
4702
+ # will happen during the next immediate window. Depending on
4703
+ # capacity, it might happen in subsequent days.
4704
+ #
4705
+ # Default: `NOW` if you don't specify a value for `DesiredStartTime`,
4706
+ # and `TIMESTAMP` if you do.
4707
+ # @return [String]
4708
+ #
4709
+ # @!attribute [rw] desired_start_time
4710
+ # The Epoch timestamp when you want the service software update to
4711
+ # start. You only need to specify this parameter if you set
4712
+ # `ScheduleAt` to `TIMESTAMP`.
4713
+ # @return [Integer]
4714
+ #
4331
4715
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdateRequest AWS API Documentation
4332
4716
  #
4333
4717
  class StartServiceSoftwareUpdateRequest < Struct.new(
4334
- :domain_name)
4718
+ :domain_name,
4719
+ :schedule_at,
4720
+ :desired_start_time)
4335
4721
  SENSITIVE = []
4336
4722
  include Aws::Structure
4337
4723
  end
@@ -4517,7 +4903,7 @@ module Aws::OpenSearchService
4517
4903
  # @return [String]
4518
4904
  #
4519
4905
  # @!attribute [rw] log_publishing_options
4520
- # Options to publish OpenSearch lots to Amazon CloudWatch Logs.
4906
+ # Options to publish OpenSearch logs to Amazon CloudWatch Logs.
4521
4907
  # @return [Hash<String,Types::LogPublishingOption>]
4522
4908
  #
4523
4909
  # @!attribute [rw] encryption_at_rest_options
@@ -4530,7 +4916,7 @@ module Aws::OpenSearchService
4530
4916
  # @return [Types::DomainEndpointOptions]
4531
4917
  #
4532
4918
  # @!attribute [rw] node_to_node_encryption_options
4533
- # Node-To-Node Encryption options for the domain.
4919
+ # Node-to-node encryption options for the domain.
4534
4920
  # @return [Types::NodeToNodeEncryptionOptions]
4535
4921
  #
4536
4922
  # @!attribute [rw] advanced_security_options
@@ -4562,6 +4948,14 @@ module Aws::OpenSearchService
4562
4948
  # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
4563
4949
  # @return [String]
4564
4950
  #
4951
+ # @!attribute [rw] off_peak_window_options
4952
+ # Off-peak window options for the domain.
4953
+ # @return [Types::OffPeakWindowOptions]
4954
+ #
4955
+ # @!attribute [rw] software_update_options
4956
+ # Service software update options for the domain.
4957
+ # @return [Types::SoftwareUpdateOptions]
4958
+ #
4565
4959
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigRequest AWS API Documentation
4566
4960
  #
4567
4961
  class UpdateDomainConfigRequest < Struct.new(
@@ -4580,7 +4974,9 @@ module Aws::OpenSearchService
4580
4974
  :advanced_security_options,
4581
4975
  :auto_tune_options,
4582
4976
  :dry_run,
4583
- :dry_run_mode)
4977
+ :dry_run_mode,
4978
+ :off_peak_window_options,
4979
+ :software_update_options)
4584
4980
  SENSITIVE = []
4585
4981
  include Aws::Structure
4586
4982
  end
@@ -4654,6 +5050,76 @@ module Aws::OpenSearchService
4654
5050
  include Aws::Structure
4655
5051
  end
4656
5052
 
5053
+ # @!attribute [rw] domain_name
5054
+ # The name of the domain to reschedule an action for.
5055
+ # @return [String]
5056
+ #
5057
+ # @!attribute [rw] action_id
5058
+ # The unique identifier of the action to reschedule. To retrieve this
5059
+ # ID, send a [ListScheduledActions][1] request.
5060
+ #
5061
+ #
5062
+ #
5063
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
5064
+ # @return [String]
5065
+ #
5066
+ # @!attribute [rw] action_type
5067
+ # The type of action to reschedule. Can be one of
5068
+ # `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or
5069
+ # `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a
5070
+ # [ListScheduledActions][1] request.
5071
+ #
5072
+ #
5073
+ #
5074
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
5075
+ # @return [String]
5076
+ #
5077
+ # @!attribute [rw] schedule_at
5078
+ # When to schedule the action.
5079
+ #
5080
+ # * `NOW` - Immediately schedules the update to happen in the current
5081
+ # hour if there's capacity available.
5082
+ #
5083
+ # * `TIMESTAMP` - Lets you specify a custom date and time to apply the
5084
+ # update. If you specify this value, you must also provide a value
5085
+ # for `DesiredStartTime`.
5086
+ #
5087
+ # * `OFF_PEAK_WINDOW` - Marks the action to be picked up during an
5088
+ # upcoming off-peak window. There's no guarantee that the change
5089
+ # will be implemented during the next immediate window. Depending on
5090
+ # capacity, it might happen in subsequent days.
5091
+ # @return [String]
5092
+ #
5093
+ # @!attribute [rw] desired_start_time
5094
+ # The time to implement the change, in Coordinated Universal Time
5095
+ # (UTC). Only specify this parameter if you set `ScheduleAt` to
5096
+ # `TIMESTAMP`.
5097
+ # @return [Integer]
5098
+ #
5099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionRequest AWS API Documentation
5100
+ #
5101
+ class UpdateScheduledActionRequest < Struct.new(
5102
+ :domain_name,
5103
+ :action_id,
5104
+ :action_type,
5105
+ :schedule_at,
5106
+ :desired_start_time)
5107
+ SENSITIVE = []
5108
+ include Aws::Structure
5109
+ end
5110
+
5111
+ # @!attribute [rw] scheduled_action
5112
+ # Information about the rescheduled action.
5113
+ # @return [Types::ScheduledAction]
5114
+ #
5115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionResponse AWS API Documentation
5116
+ #
5117
+ class UpdateScheduledActionResponse < Struct.new(
5118
+ :scheduled_action)
5119
+ SENSITIVE = []
5120
+ include Aws::Structure
5121
+ end
5122
+
4657
5123
  # @!attribute [rw] vpc_endpoint_id
4658
5124
  # The unique identifier of the endpoint.
4659
5125
  # @return [String]
@@ -4936,8 +5402,7 @@ module Aws::OpenSearchService
4936
5402
  include Aws::Structure
4937
5403
  end
4938
5404
 
4939
- # An exception for missing / invalid input fields. Gives http status
4940
- # code of 400.
5405
+ # An exception for accessing or deleting a resource that doesn't exist.
4941
5406
  #
4942
5407
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ValidationException AWS API Documentation
4943
5408
  #
@@ -5081,6 +5546,30 @@ module Aws::OpenSearchService
5081
5546
  include Aws::Structure
5082
5547
  end
5083
5548
 
5549
+ # The desired start time for an [off-peak maintenance window][1].
5550
+ #
5551
+ #
5552
+ #
5553
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
5554
+ #
5555
+ # @!attribute [rw] hours
5556
+ # The start hour of the window in Coordinated Universal Time (UTC),
5557
+ # using 24-hour time. For example, `17` refers to 5:00 P.M. UTC.
5558
+ # @return [Integer]
5559
+ #
5560
+ # @!attribute [rw] minutes
5561
+ # The start minute of the window, in UTC.
5562
+ # @return [Integer]
5563
+ #
5564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/WindowStartTime AWS API Documentation
5565
+ #
5566
+ class WindowStartTime < Struct.new(
5567
+ :hours,
5568
+ :minutes)
5569
+ SENSITIVE = []
5570
+ include Aws::Structure
5571
+ end
5572
+
5084
5573
  # The zone awareness configuration for an Amazon OpenSearch Service
5085
5574
  # domain.
5086
5575
  #