aws-sdk-elasticsearchservice 1.68.0 → 1.70.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -13,13 +13,6 @@ module Aws::ElasticsearchService
13
13
  # Container for the parameters to the
14
14
  # `AcceptInboundCrossClusterSearchConnection` operation.
15
15
  #
16
- # @note When making an API call, you may pass AcceptInboundCrossClusterSearchConnectionRequest
17
- # data as a hash:
18
- #
19
- # {
20
- # cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
21
- # }
22
- #
23
16
  # @!attribute [rw] cross_cluster_search_connection_id
24
17
  # The id of the inbound connection that you want to accept.
25
18
  # @return [String]
@@ -77,19 +70,6 @@ module Aws::ElasticsearchService
77
70
  # Container for the parameters to the `AddTags` operation. Specify the
78
71
  # tags that you want to attach to the Elasticsearch domain.
79
72
  #
80
- # @note When making an API call, you may pass AddTagsRequest
81
- # data as a hash:
82
- #
83
- # {
84
- # arn: "ARN", # required
85
- # tag_list: [ # required
86
- # {
87
- # key: "TagKey", # required
88
- # value: "TagValue", # required
89
- # },
90
- # ],
91
- # }
92
- #
93
73
  # @!attribute [rw] arn
94
74
  # Specify the `ARN` for which you want to add the tags.
95
75
  # @return [String]
@@ -202,32 +182,6 @@ module Aws::ElasticsearchService
202
182
  # master username and password (if internal database is enabled), and
203
183
  # master user ARN (if IAM is enabled).
204
184
  #
205
- # @note When making an API call, you may pass AdvancedSecurityOptionsInput
206
- # data as a hash:
207
- #
208
- # {
209
- # enabled: false,
210
- # internal_user_database_enabled: false,
211
- # master_user_options: {
212
- # master_user_arn: "ARN",
213
- # master_user_name: "Username",
214
- # master_user_password: "Password",
215
- # },
216
- # saml_options: {
217
- # enabled: false,
218
- # idp: {
219
- # metadata_content: "SAMLMetadata", # required
220
- # entity_id: "SAMLEntityId", # required
221
- # },
222
- # master_user_name: "Username",
223
- # master_backend_role: "BackendRole",
224
- # subject_key: "String",
225
- # roles_key: "String",
226
- # session_timeout_minutes: 1,
227
- # },
228
- # anonymous_auth_enabled: false,
229
- # }
230
- #
231
185
  # @!attribute [rw] enabled
232
186
  # True if advanced security is enabled.
233
187
  # @return [Boolean]
@@ -282,14 +236,6 @@ module Aws::ElasticsearchService
282
236
 
283
237
  # Container for request parameters to ` AssociatePackage ` operation.
284
238
  #
285
- # @note When making an API call, you may pass AssociatePackageRequest
286
- # data as a hash:
287
- #
288
- # {
289
- # package_id: "PackageID", # required
290
- # domain_name: "DomainName", # required
291
- # }
292
- #
293
239
  # @!attribute [rw] package_id
294
240
  # Internal ID of the package that you want to associate with a domain.
295
241
  # Use `DescribePackages` to find this value.
@@ -322,14 +268,6 @@ module Aws::ElasticsearchService
322
268
  # operation. Specifies the account to be permitted to manage VPC
323
269
  # endpoints against the domain.
324
270
  #
325
- # @note When making an API call, you may pass AuthorizeVpcEndpointAccessRequest
326
- # data as a hash:
327
- #
328
- # {
329
- # domain_name: "DomainName", # required
330
- # account: "AWSAccount", # required
331
- # }
332
- #
333
271
  # @!attribute [rw] domain_name
334
272
  # The name of the OpenSearch Service domain to provide access to.
335
273
  # @return [String]
@@ -430,18 +368,6 @@ module Aws::ElasticsearchService
430
368
  #
431
369
  # [1]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html
432
370
  #
433
- # @note When making an API call, you may pass AutoTuneMaintenanceSchedule
434
- # data as a hash:
435
- #
436
- # {
437
- # start_at: Time.now,
438
- # duration: {
439
- # value: 1,
440
- # unit: "HOURS", # accepts HOURS
441
- # },
442
- # cron_expression_for_recurrence: "String",
443
- # }
444
- #
445
371
  # @!attribute [rw] start_at
446
372
  # Specifies timestamp at which Auto-Tune maintenance schedule start.
447
373
  # @return [Time]
@@ -476,24 +402,6 @@ module Aws::ElasticsearchService
476
402
  # domain, rollback state when disabling Auto-Tune options and list of
477
403
  # maintenance schedules.
478
404
  #
479
- # @note When making an API call, you may pass AutoTuneOptions
480
- # data as a hash:
481
- #
482
- # {
483
- # desired_state: "ENABLED", # accepts ENABLED, DISABLED
484
- # rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
485
- # maintenance_schedules: [
486
- # {
487
- # start_at: Time.now,
488
- # duration: {
489
- # value: 1,
490
- # unit: "HOURS", # accepts HOURS
491
- # },
492
- # cron_expression_for_recurrence: "String",
493
- # },
494
- # ],
495
- # }
496
- #
497
405
  # @!attribute [rw] desired_state
498
406
  # Specifies the Auto-Tune desired state. Valid values are ENABLED,
499
407
  # DISABLED.
@@ -524,23 +432,6 @@ module Aws::ElasticsearchService
524
432
  # Specifies the Auto-Tune options: the Auto-Tune desired state for the
525
433
  # domain and list of maintenance schedules.
526
434
  #
527
- # @note When making an API call, you may pass AutoTuneOptionsInput
528
- # data as a hash:
529
- #
530
- # {
531
- # desired_state: "ENABLED", # accepts ENABLED, DISABLED
532
- # maintenance_schedules: [
533
- # {
534
- # start_at: Time.now,
535
- # duration: {
536
- # value: 1,
537
- # unit: "HOURS", # accepts HOURS
538
- # },
539
- # cron_expression_for_recurrence: "String",
540
- # },
541
- # ],
542
- # }
543
- #
544
435
  # @!attribute [rw] desired_state
545
436
  # Specifies the Auto-Tune desired state. Valid values are ENABLED,
546
437
  # DISABLED.
@@ -655,13 +546,6 @@ module Aws::ElasticsearchService
655
546
  # name of the Elasticsearch domain that you wish to cancel a service
656
547
  # software update on.
657
548
  #
658
- # @note When making an API call, you may pass CancelElasticsearchServiceSoftwareUpdateRequest
659
- # data as a hash:
660
- #
661
- # {
662
- # domain_name: "DomainName", # required
663
- # }
664
- #
665
549
  # @!attribute [rw] domain_name
666
550
  # The name of the domain that you want to stop the latest service
667
551
  # software update on.
@@ -788,16 +672,6 @@ module Aws::ElasticsearchService
788
672
  #
789
673
  # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html
790
674
  #
791
- # @note When making an API call, you may pass CognitoOptions
792
- # data as a hash:
793
- #
794
- # {
795
- # enabled: false,
796
- # user_pool_id: "UserPoolId",
797
- # identity_pool_id: "IdentityPoolId",
798
- # role_arn: "RoleArn",
799
- # }
800
- #
801
675
  # @!attribute [rw] enabled
802
676
  # Specifies the option to enable Cognito for Kibana authentication.
803
677
  # @return [Boolean]
@@ -845,13 +719,6 @@ module Aws::ElasticsearchService
845
719
 
846
720
  # Specifies the configuration for cold storage options such as enabled
847
721
  #
848
- # @note When making an API call, you may pass ColdStorageOptions
849
- # data as a hash:
850
- #
851
- # {
852
- # enabled: false, # required
853
- # }
854
- #
855
722
  # @!attribute [rw] enabled
856
723
  # Enable cold storage option. Accepted values true or false
857
724
  # @return [Boolean]
@@ -885,116 +752,6 @@ module Aws::ElasticsearchService
885
752
  #
886
753
  class ConflictException < Aws::EmptyStructure; end
887
754
 
888
- # @note When making an API call, you may pass CreateElasticsearchDomainRequest
889
- # data as a hash:
890
- #
891
- # {
892
- # domain_name: "DomainName", # required
893
- # elasticsearch_version: "ElasticsearchVersionString",
894
- # elasticsearch_cluster_config: {
895
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
896
- # instance_count: 1,
897
- # dedicated_master_enabled: false,
898
- # zone_awareness_enabled: false,
899
- # zone_awareness_config: {
900
- # availability_zone_count: 1,
901
- # },
902
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
903
- # dedicated_master_count: 1,
904
- # warm_enabled: false,
905
- # warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
906
- # warm_count: 1,
907
- # cold_storage_options: {
908
- # enabled: false, # required
909
- # },
910
- # },
911
- # ebs_options: {
912
- # ebs_enabled: false,
913
- # volume_type: "standard", # accepts standard, gp2, io1, gp3
914
- # volume_size: 1,
915
- # iops: 1,
916
- # throughput: 1,
917
- # },
918
- # access_policies: "PolicyDocument",
919
- # snapshot_options: {
920
- # automated_snapshot_start_hour: 1,
921
- # },
922
- # vpc_options: {
923
- # subnet_ids: ["String"],
924
- # security_group_ids: ["String"],
925
- # },
926
- # cognito_options: {
927
- # enabled: false,
928
- # user_pool_id: "UserPoolId",
929
- # identity_pool_id: "IdentityPoolId",
930
- # role_arn: "RoleArn",
931
- # },
932
- # encryption_at_rest_options: {
933
- # enabled: false,
934
- # kms_key_id: "KmsKeyId",
935
- # },
936
- # node_to_node_encryption_options: {
937
- # enabled: false,
938
- # },
939
- # advanced_options: {
940
- # "String" => "String",
941
- # },
942
- # log_publishing_options: {
943
- # "INDEX_SLOW_LOGS" => {
944
- # cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
945
- # enabled: false,
946
- # },
947
- # },
948
- # domain_endpoint_options: {
949
- # enforce_https: false,
950
- # tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
951
- # custom_endpoint_enabled: false,
952
- # custom_endpoint: "DomainNameFqdn",
953
- # custom_endpoint_certificate_arn: "ARN",
954
- # },
955
- # advanced_security_options: {
956
- # enabled: false,
957
- # internal_user_database_enabled: false,
958
- # master_user_options: {
959
- # master_user_arn: "ARN",
960
- # master_user_name: "Username",
961
- # master_user_password: "Password",
962
- # },
963
- # saml_options: {
964
- # enabled: false,
965
- # idp: {
966
- # metadata_content: "SAMLMetadata", # required
967
- # entity_id: "SAMLEntityId", # required
968
- # },
969
- # master_user_name: "Username",
970
- # master_backend_role: "BackendRole",
971
- # subject_key: "String",
972
- # roles_key: "String",
973
- # session_timeout_minutes: 1,
974
- # },
975
- # anonymous_auth_enabled: false,
976
- # },
977
- # auto_tune_options: {
978
- # desired_state: "ENABLED", # accepts ENABLED, DISABLED
979
- # maintenance_schedules: [
980
- # {
981
- # start_at: Time.now,
982
- # duration: {
983
- # value: 1,
984
- # unit: "HOURS", # accepts HOURS
985
- # },
986
- # cron_expression_for_recurrence: "String",
987
- # },
988
- # ],
989
- # },
990
- # tag_list: [
991
- # {
992
- # key: "TagKey", # required
993
- # value: "TagValue", # required
994
- # },
995
- # ],
996
- # }
997
- #
998
755
  # @!attribute [rw] domain_name
999
756
  # The name of the Elasticsearch domain that you are creating. Domain
1000
757
  # names are unique across the domains owned by an account within an
@@ -1131,23 +888,6 @@ module Aws::ElasticsearchService
1131
888
  # Container for the parameters to the
1132
889
  # `CreateOutboundCrossClusterSearchConnection` operation.
1133
890
  #
1134
- # @note When making an API call, you may pass CreateOutboundCrossClusterSearchConnectionRequest
1135
- # data as a hash:
1136
- #
1137
- # {
1138
- # source_domain_info: { # required
1139
- # owner_id: "OwnerId",
1140
- # domain_name: "DomainName", # required
1141
- # region: "Region",
1142
- # },
1143
- # destination_domain_info: { # required
1144
- # owner_id: "OwnerId",
1145
- # domain_name: "DomainName", # required
1146
- # region: "Region",
1147
- # },
1148
- # connection_alias: "ConnectionAlias", # required
1149
- # }
1150
- #
1151
891
  # @!attribute [rw] source_domain_info
1152
892
  # Specifies the `DomainInformation` for the source Elasticsearch
1153
893
  # domain.
@@ -1212,19 +952,6 @@ module Aws::ElasticsearchService
1212
952
 
1213
953
  # Container for request parameters to ` CreatePackage ` operation.
1214
954
  #
1215
- # @note When making an API call, you may pass CreatePackageRequest
1216
- # data as a hash:
1217
- #
1218
- # {
1219
- # package_name: "PackageName", # required
1220
- # package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY
1221
- # package_description: "PackageDescription",
1222
- # package_source: { # required
1223
- # s3_bucket_name: "S3BucketName",
1224
- # s3_key: "S3Key",
1225
- # },
1226
- # }
1227
- #
1228
955
  # @!attribute [rw] package_name
1229
956
  # Unique identifier for the package.
1230
957
  # @return [String]
@@ -1265,18 +992,6 @@ module Aws::ElasticsearchService
1265
992
  # Container for the parameters to the `CreateVpcEndpointRequest`
1266
993
  # operation.
1267
994
  #
1268
- # @note When making an API call, you may pass CreateVpcEndpointRequest
1269
- # data as a hash:
1270
- #
1271
- # {
1272
- # domain_arn: "DomainArn", # required
1273
- # vpc_options: { # required
1274
- # subnet_ids: ["String"],
1275
- # security_group_ids: ["String"],
1276
- # },
1277
- # client_token: "ClientToken",
1278
- # }
1279
- #
1280
995
  # @!attribute [rw] domain_arn
1281
996
  # The Amazon Resource Name (ARN) of the domain to grant access to.
1282
997
  # @return [String]
@@ -1316,13 +1031,6 @@ module Aws::ElasticsearchService
1316
1031
  # operation. Specifies the name of the Elasticsearch domain that you
1317
1032
  # want to delete.
1318
1033
  #
1319
- # @note When making an API call, you may pass DeleteElasticsearchDomainRequest
1320
- # data as a hash:
1321
- #
1322
- # {
1323
- # domain_name: "DomainName", # required
1324
- # }
1325
- #
1326
1034
  # @!attribute [rw] domain_name
1327
1035
  # The name of the Elasticsearch domain that you want to permanently
1328
1036
  # delete.
@@ -1351,13 +1059,6 @@ module Aws::ElasticsearchService
1351
1059
  # Container for the parameters to the
1352
1060
  # `DeleteInboundCrossClusterSearchConnection` operation.
1353
1061
  #
1354
- # @note When making an API call, you may pass DeleteInboundCrossClusterSearchConnectionRequest
1355
- # data as a hash:
1356
- #
1357
- # {
1358
- # cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
1359
- # }
1360
- #
1361
1062
  # @!attribute [rw] cross_cluster_search_connection_id
1362
1063
  # The id of the inbound connection that you want to permanently
1363
1064
  # delete.
@@ -1386,13 +1087,6 @@ module Aws::ElasticsearchService
1386
1087
  # Container for the parameters to the
1387
1088
  # `DeleteOutboundCrossClusterSearchConnection` operation.
1388
1089
  #
1389
- # @note When making an API call, you may pass DeleteOutboundCrossClusterSearchConnectionRequest
1390
- # data as a hash:
1391
- #
1392
- # {
1393
- # cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
1394
- # }
1395
- #
1396
1090
  # @!attribute [rw] cross_cluster_search_connection_id
1397
1091
  # The id of the outbound connection that you want to permanently
1398
1092
  # delete.
@@ -1420,13 +1114,6 @@ module Aws::ElasticsearchService
1420
1114
 
1421
1115
  # Container for request parameters to ` DeletePackage ` operation.
1422
1116
  #
1423
- # @note When making an API call, you may pass DeletePackageRequest
1424
- # data as a hash:
1425
- #
1426
- # {
1427
- # package_id: "PackageID", # required
1428
- # }
1429
- #
1430
1117
  # @!attribute [rw] package_id
1431
1118
  # Internal ID of the package that you want to delete. Use
1432
1119
  # `DescribePackages` to find this value.
@@ -1452,13 +1139,6 @@ module Aws::ElasticsearchService
1452
1139
 
1453
1140
  # Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
1454
1141
  #
1455
- # @note When making an API call, you may pass DeleteVpcEndpointRequest
1456
- # data as a hash:
1457
- #
1458
- # {
1459
- # vpc_endpoint_id: "VpcEndpointId", # required
1460
- # }
1461
- #
1462
1142
  # @!attribute [rw] vpc_endpoint_id
1463
1143
  # The unique identifier of the endpoint to be deleted.
1464
1144
  # @return [String]
@@ -1487,15 +1167,6 @@ module Aws::ElasticsearchService
1487
1167
  # Container for the parameters to the `DescribeDomainAutoTunes`
1488
1168
  # operation.
1489
1169
  #
1490
- # @note When making an API call, you may pass DescribeDomainAutoTunesRequest
1491
- # data as a hash:
1492
- #
1493
- # {
1494
- # domain_name: "DomainName", # required
1495
- # max_results: 1,
1496
- # next_token: "NextToken",
1497
- # }
1498
- #
1499
1170
  # @!attribute [rw] domain_name
1500
1171
  # Specifies the domain name for which you want Auto-Tune action
1501
1172
  # details.
@@ -1550,14 +1221,6 @@ module Aws::ElasticsearchService
1550
1221
  # operation. Specifies the domain name and optional change specific
1551
1222
  # identity for which you want progress information.
1552
1223
  #
1553
- # @note When making an API call, you may pass DescribeDomainChangeProgressRequest
1554
- # data as a hash:
1555
- #
1556
- # {
1557
- # domain_name: "DomainName", # required
1558
- # change_id: "GUID",
1559
- # }
1560
- #
1561
1224
  # @!attribute [rw] domain_name
1562
1225
  # The domain you want to get the progress information about.
1563
1226
  # @return [String]
@@ -1593,13 +1256,6 @@ module Aws::ElasticsearchService
1593
1256
  # `DescribeElasticsearchDomainConfig` operation. Specifies the domain
1594
1257
  # name for which you want configuration information.
1595
1258
  #
1596
- # @note When making an API call, you may pass DescribeElasticsearchDomainConfigRequest
1597
- # data as a hash:
1598
- #
1599
- # {
1600
- # domain_name: "DomainName", # required
1601
- # }
1602
- #
1603
1259
  # @!attribute [rw] domain_name
1604
1260
  # The Elasticsearch domain that you want to get information about.
1605
1261
  # @return [String]
@@ -1627,13 +1283,6 @@ module Aws::ElasticsearchService
1627
1283
  # Container for the parameters to the `DescribeElasticsearchDomain`
1628
1284
  # operation.
1629
1285
  #
1630
- # @note When making an API call, you may pass DescribeElasticsearchDomainRequest
1631
- # data as a hash:
1632
- #
1633
- # {
1634
- # domain_name: "DomainName", # required
1635
- # }
1636
- #
1637
1286
  # @!attribute [rw] domain_name
1638
1287
  # The name of the Elasticsearch domain for which you want information.
1639
1288
  # @return [String]
@@ -1661,13 +1310,6 @@ module Aws::ElasticsearchService
1661
1310
  # operation. By default, the API returns the status of all Elasticsearch
1662
1311
  # domains.
1663
1312
  #
1664
- # @note When making an API call, you may pass DescribeElasticsearchDomainsRequest
1665
- # data as a hash:
1666
- #
1667
- # {
1668
- # domain_names: ["DomainName"], # required
1669
- # }
1670
- #
1671
1313
  # @!attribute [rw] domain_names
1672
1314
  # The Elasticsearch domains for which you want information.
1673
1315
  # @return [Array<String>]
@@ -1695,15 +1337,6 @@ module Aws::ElasticsearchService
1695
1337
  # Container for the parameters to `
1696
1338
  # DescribeElasticsearchInstanceTypeLimits ` operation.
1697
1339
  #
1698
- # @note When making an API call, you may pass DescribeElasticsearchInstanceTypeLimitsRequest
1699
- # data as a hash:
1700
- #
1701
- # {
1702
- # domain_name: "DomainName",
1703
- # instance_type: "m3.medium.elasticsearch", # required, accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
1704
- # elasticsearch_version: "ElasticsearchVersionString", # required
1705
- # }
1706
- #
1707
1340
  # @!attribute [rw] domain_name
1708
1341
  # DomainName represents the name of the Domain that we are trying to
1709
1342
  # modify. This should be present only if we are querying for
@@ -1747,20 +1380,6 @@ module Aws::ElasticsearchService
1747
1380
  # Container for the parameters to the
1748
1381
  # `DescribeInboundCrossClusterSearchConnections` operation.
1749
1382
  #
1750
- # @note When making an API call, you may pass DescribeInboundCrossClusterSearchConnectionsRequest
1751
- # data as a hash:
1752
- #
1753
- # {
1754
- # filters: [
1755
- # {
1756
- # name: "NonEmptyString",
1757
- # values: ["NonEmptyString"],
1758
- # },
1759
- # ],
1760
- # max_results: 1,
1761
- # next_token: "NextToken",
1762
- # }
1763
- #
1764
1383
  # @!attribute [rw] filters
1765
1384
  # A list of filters used to match properties for inbound cross-cluster
1766
1385
  # search connection. Available `Filter` names for this operation are:
@@ -1814,20 +1433,6 @@ module Aws::ElasticsearchService
1814
1433
  # Container for the parameters to the
1815
1434
  # `DescribeOutboundCrossClusterSearchConnections` operation.
1816
1435
  #
1817
- # @note When making an API call, you may pass DescribeOutboundCrossClusterSearchConnectionsRequest
1818
- # data as a hash:
1819
- #
1820
- # {
1821
- # filters: [
1822
- # {
1823
- # name: "NonEmptyString",
1824
- # values: ["NonEmptyString"],
1825
- # },
1826
- # ],
1827
- # max_results: 1,
1828
- # next_token: "NextToken",
1829
- # }
1830
- #
1831
1436
  # @!attribute [rw] filters
1832
1437
  # A list of filters used to match properties for outbound
1833
1438
  # cross-cluster search connection. Available `Filter` names for this
@@ -1880,20 +1485,12 @@ module Aws::ElasticsearchService
1880
1485
 
1881
1486
  # Filter to apply in `DescribePackage` response.
1882
1487
  #
1883
- # @note When making an API call, you may pass DescribePackagesFilter
1884
- # data as a hash:
1885
- #
1886
- # {
1887
- # name: "PackageID", # accepts PackageID, PackageName, PackageStatus
1888
- # value: ["DescribePackagesFilterValue"],
1889
- # }
1890
- #
1891
1488
  # @!attribute [rw] name
1892
1489
  # Any field from `PackageDetails`.
1893
1490
  # @return [String]
1894
1491
  #
1895
1492
  # @!attribute [rw] value
1896
- # A list of values for the specified field.
1493
+ # A non-empty list of values for the specified field.
1897
1494
  # @return [Array<String>]
1898
1495
  #
1899
1496
  class DescribePackagesFilter < Struct.new(
@@ -1905,20 +1502,6 @@ module Aws::ElasticsearchService
1905
1502
 
1906
1503
  # Container for request parameters to ` DescribePackage ` operation.
1907
1504
  #
1908
- # @note When making an API call, you may pass DescribePackagesRequest
1909
- # data as a hash:
1910
- #
1911
- # {
1912
- # filters: [
1913
- # {
1914
- # name: "PackageID", # accepts PackageID, PackageName, PackageStatus
1915
- # value: ["DescribePackagesFilterValue"],
1916
- # },
1917
- # ],
1918
- # max_results: 1,
1919
- # next_token: "NextToken",
1920
- # }
1921
- #
1922
1505
  # @!attribute [rw] filters
1923
1506
  # Only returns packages that match the `DescribePackagesFilterList`
1924
1507
  # values.
@@ -1961,15 +1544,6 @@ module Aws::ElasticsearchService
1961
1544
  # Container for parameters to
1962
1545
  # `DescribeReservedElasticsearchInstanceOfferings`
1963
1546
  #
1964
- # @note When making an API call, you may pass DescribeReservedElasticsearchInstanceOfferingsRequest
1965
- # data as a hash:
1966
- #
1967
- # {
1968
- # reserved_elasticsearch_instance_offering_id: "GUID",
1969
- # max_results: 1,
1970
- # next_token: "NextToken",
1971
- # }
1972
- #
1973
1547
  # @!attribute [rw] reserved_elasticsearch_instance_offering_id
1974
1548
  # The offering identifier filter value. Use this parameter to show
1975
1549
  # only the available offering that matches the specified reservation
@@ -2014,15 +1588,6 @@ module Aws::ElasticsearchService
2014
1588
 
2015
1589
  # Container for parameters to `DescribeReservedElasticsearchInstances`
2016
1590
  #
2017
- # @note When making an API call, you may pass DescribeReservedElasticsearchInstancesRequest
2018
- # data as a hash:
2019
- #
2020
- # {
2021
- # reserved_elasticsearch_instance_id: "GUID",
2022
- # max_results: 1,
2023
- # next_token: "NextToken",
2024
- # }
2025
- #
2026
1591
  # @!attribute [rw] reserved_elasticsearch_instance_id
2027
1592
  # The reserved instance identifier filter value. Use this parameter to
2028
1593
  # show only the reservation that matches the specified reserved
@@ -2067,13 +1632,6 @@ module Aws::ElasticsearchService
2067
1632
  # Container for request parameters to the `DescribeVpcEndpoints`
2068
1633
  # operation. Specifies the list of VPC endpoints to be described.
2069
1634
  #
2070
- # @note When making an API call, you may pass DescribeVpcEndpointsRequest
2071
- # data as a hash:
2072
- #
2073
- # {
2074
- # vpc_endpoint_ids: ["VpcEndpointId"], # required
2075
- # }
2076
- #
2077
1635
  # @!attribute [rw] vpc_endpoint_ids
2078
1636
  # The unique identifiers of the endpoints to get information about.
2079
1637
  # @return [Array<String>]
@@ -2111,14 +1669,6 @@ module Aws::ElasticsearchService
2111
1669
 
2112
1670
  # Container for request parameters to ` DissociatePackage ` operation.
2113
1671
  #
2114
- # @note When making an API call, you may pass DissociatePackageRequest
2115
- # data as a hash:
2116
- #
2117
- # {
2118
- # package_id: "PackageID", # required
2119
- # domain_name: "DomainName", # required
2120
- # }
2121
- #
2122
1672
  # @!attribute [rw] package_id
2123
1673
  # Internal ID of the package that you want to associate with a domain.
2124
1674
  # Use `DescribePackages` to find this value.
@@ -2149,17 +1699,6 @@ module Aws::ElasticsearchService
2149
1699
 
2150
1700
  # Options to configure endpoint for the Elasticsearch domain.
2151
1701
  #
2152
- # @note When making an API call, you may pass DomainEndpointOptions
2153
- # data as a hash:
2154
- #
2155
- # {
2156
- # enforce_https: false,
2157
- # tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
2158
- # custom_endpoint_enabled: false,
2159
- # custom_endpoint: "DomainNameFqdn",
2160
- # custom_endpoint_certificate_arn: "ARN",
2161
- # }
2162
- #
2163
1702
  # @!attribute [rw] enforce_https
2164
1703
  # Specify if only HTTPS endpoint should be enabled for the
2165
1704
  # Elasticsearch domain.
@@ -2232,15 +1771,6 @@ module Aws::ElasticsearchService
2232
1771
  include Aws::Structure
2233
1772
  end
2234
1773
 
2235
- # @note When making an API call, you may pass DomainInformation
2236
- # data as a hash:
2237
- #
2238
- # {
2239
- # owner_id: "OwnerId",
2240
- # domain_name: "DomainName", # required
2241
- # region: "Region",
2242
- # }
2243
- #
2244
1774
  # @!attribute [rw] owner_id
2245
1775
  # @return [String]
2246
1776
  #
@@ -2345,14 +1875,6 @@ module Aws::ElasticsearchService
2345
1875
  #
2346
1876
  # [1]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html
2347
1877
  #
2348
- # @note When making an API call, you may pass Duration
2349
- # data as a hash:
2350
- #
2351
- # {
2352
- # value: 1,
2353
- # unit: "HOURS", # accepts HOURS
2354
- # }
2355
- #
2356
1878
  # @!attribute [rw] value
2357
1879
  # Integer to specify the value of a maintenance schedule duration. See
2358
1880
  # the [Developer Guide][1] for more information.
@@ -2386,17 +1908,6 @@ module Aws::ElasticsearchService
2386
1908
  #
2387
1909
  # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs
2388
1910
  #
2389
- # @note When making an API call, you may pass EBSOptions
2390
- # data as a hash:
2391
- #
2392
- # {
2393
- # ebs_enabled: false,
2394
- # volume_type: "standard", # accepts standard, gp2, io1, gp3
2395
- # volume_size: 1,
2396
- # iops: 1,
2397
- # throughput: 1,
2398
- # }
2399
- #
2400
1911
  # @!attribute [rw] ebs_enabled
2401
1912
  # Specifies whether EBS-based storage is enabled.
2402
1913
  # @return [Boolean]
@@ -2448,27 +1959,6 @@ module Aws::ElasticsearchService
2448
1959
  # Specifies the configuration for the domain cluster, such as the type
2449
1960
  # and number of instances.
2450
1961
  #
2451
- # @note When making an API call, you may pass ElasticsearchClusterConfig
2452
- # data as a hash:
2453
- #
2454
- # {
2455
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
2456
- # instance_count: 1,
2457
- # dedicated_master_enabled: false,
2458
- # zone_awareness_enabled: false,
2459
- # zone_awareness_config: {
2460
- # availability_zone_count: 1,
2461
- # },
2462
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
2463
- # dedicated_master_count: 1,
2464
- # warm_enabled: false,
2465
- # warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
2466
- # warm_count: 1,
2467
- # cold_storage_options: {
2468
- # enabled: false, # required
2469
- # },
2470
- # }
2471
- #
2472
1962
  # @!attribute [rw] instance_type
2473
1963
  # The instance type for an Elasticsearch cluster. UltraWarm instance
2474
1964
  # types are not supported for data instances.
@@ -2706,7 +2196,7 @@ module Aws::ElasticsearchService
2706
2196
  #
2707
2197
  # @!attribute [rw] endpoints
2708
2198
  # Map containing the Elasticsearch domain endpoints used to submit
2709
- # index and search requests. Example `key, value`\:
2199
+ # index and search requests. Example `key, value`:
2710
2200
  # `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.
2711
2201
  # @return [Hash<String,String>]
2712
2202
  #
@@ -2853,14 +2343,6 @@ module Aws::ElasticsearchService
2853
2343
 
2854
2344
  # Specifies the Encryption At Rest Options.
2855
2345
  #
2856
- # @note When making an API call, you may pass EncryptionAtRestOptions
2857
- # data as a hash:
2858
- #
2859
- # {
2860
- # enabled: false,
2861
- # kms_key_id: "KmsKeyId",
2862
- # }
2863
- #
2864
2346
  # @!attribute [rw] enabled
2865
2347
  # Specifies the option to enable Encryption At Rest.
2866
2348
  # @return [Boolean]
@@ -2914,14 +2396,6 @@ module Aws::ElasticsearchService
2914
2396
  # filter. A cross-cluster search connection must match at least one of
2915
2397
  # the specified values for it to be returned from an operation.
2916
2398
  #
2917
- # @note When making an API call, you may pass Filter
2918
- # data as a hash:
2919
- #
2920
- # {
2921
- # name: "NonEmptyString",
2922
- # values: ["NonEmptyString"],
2923
- # }
2924
- #
2925
2399
  # @!attribute [rw] name
2926
2400
  # Specifies the name of the filter.
2927
2401
  # @return [String]
@@ -2940,13 +2414,6 @@ module Aws::ElasticsearchService
2940
2414
  # Container for request parameters to `
2941
2415
  # GetCompatibleElasticsearchVersions ` operation.
2942
2416
  #
2943
- # @note When making an API call, you may pass GetCompatibleElasticsearchVersionsRequest
2944
- # data as a hash:
2945
- #
2946
- # {
2947
- # domain_name: "DomainName",
2948
- # }
2949
- #
2950
2417
  # @!attribute [rw] domain_name
2951
2418
  # The name of an Elasticsearch domain. Domain names are unique across
2952
2419
  # the domains owned by an account within an AWS region. Domain names
@@ -2977,15 +2444,6 @@ module Aws::ElasticsearchService
2977
2444
  # Container for request parameters to ` GetPackageVersionHistory `
2978
2445
  # operation.
2979
2446
  #
2980
- # @note When making an API call, you may pass GetPackageVersionHistoryRequest
2981
- # data as a hash:
2982
- #
2983
- # {
2984
- # package_id: "PackageID", # required
2985
- # max_results: 1,
2986
- # next_token: "NextToken",
2987
- # }
2988
- #
2989
2447
  # @!attribute [rw] package_id
2990
2448
  # Returns an audit history of versions of the package.
2991
2449
  # @return [String]
@@ -3031,15 +2489,6 @@ module Aws::ElasticsearchService
3031
2489
 
3032
2490
  # Container for request parameters to ` GetUpgradeHistory ` operation.
3033
2491
  #
3034
- # @note When making an API call, you may pass GetUpgradeHistoryRequest
3035
- # data as a hash:
3036
- #
3037
- # {
3038
- # domain_name: "DomainName", # required
3039
- # max_results: 1,
3040
- # next_token: "NextToken",
3041
- # }
3042
- #
3043
2492
  # @!attribute [rw] domain_name
3044
2493
  # The name of an Elasticsearch domain. Domain names are unique across
3045
2494
  # the domains owned by an account within an AWS region. Domain names
@@ -3087,13 +2536,6 @@ module Aws::ElasticsearchService
3087
2536
 
3088
2537
  # Container for request parameters to ` GetUpgradeStatus ` operation.
3089
2538
  #
3090
- # @note When making an API call, you may pass GetUpgradeStatusRequest
3091
- # data as a hash:
3092
- #
3093
- # {
3094
- # domain_name: "DomainName", # required
3095
- # }
3096
- #
3097
2539
  # @!attribute [rw] domain_name
3098
2540
  # The name of an Elasticsearch domain. Domain names are unique across
3099
2541
  # the domains owned by an account within an AWS region. Domain names
@@ -3280,13 +2722,6 @@ module Aws::ElasticsearchService
3280
2722
 
3281
2723
  # Container for the parameters to the `ListDomainNames` operation.
3282
2724
  #
3283
- # @note When making an API call, you may pass ListDomainNamesRequest
3284
- # data as a hash:
3285
- #
3286
- # {
3287
- # engine_type: "OpenSearch", # accepts OpenSearch, Elasticsearch
3288
- # }
3289
- #
3290
2725
  # @!attribute [rw] engine_type
3291
2726
  # Optional parameter to filter the output by domain engine type.
3292
2727
  # Acceptable values are 'Elasticsearch' and 'OpenSearch'.
@@ -3314,15 +2749,6 @@ module Aws::ElasticsearchService
3314
2749
  # Container for request parameters to ` ListDomainsForPackage `
3315
2750
  # operation.
3316
2751
  #
3317
- # @note When making an API call, you may pass ListDomainsForPackageRequest
3318
- # data as a hash:
3319
- #
3320
- # {
3321
- # package_id: "PackageID", # required
3322
- # max_results: 1,
3323
- # next_token: "NextToken",
3324
- # }
3325
- #
3326
2752
  # @!attribute [rw] package_id
3327
2753
  # The package for which to list domains.
3328
2754
  # @return [String]
@@ -3365,16 +2791,6 @@ module Aws::ElasticsearchService
3365
2791
  # Container for the parameters to the ` ListElasticsearchInstanceTypes `
3366
2792
  # operation.
3367
2793
  #
3368
- # @note When making an API call, you may pass ListElasticsearchInstanceTypesRequest
3369
- # data as a hash:
3370
- #
3371
- # {
3372
- # elasticsearch_version: "ElasticsearchVersionString", # required
3373
- # domain_name: "DomainName",
3374
- # max_results: 1,
3375
- # next_token: "NextToken",
3376
- # }
3377
- #
3378
2794
  # @!attribute [rw] elasticsearch_version
3379
2795
  # Version of Elasticsearch for which list of supported elasticsearch
3380
2796
  # instance types are needed.
@@ -3436,14 +2852,6 @@ module Aws::ElasticsearchService
3436
2852
  # received response does not contain a NextToken, then there are no more
3437
2853
  # results to retrieve.
3438
2854
  #
3439
- # @note When making an API call, you may pass ListElasticsearchVersionsRequest
3440
- # data as a hash:
3441
- #
3442
- # {
3443
- # max_results: 1,
3444
- # next_token: "NextToken",
3445
- # }
3446
- #
3447
2855
  # @!attribute [rw] max_results
3448
2856
  # Set this value to limit the number of results returned. Value
3449
2857
  # provided must be greater than 10 else it wont be honored.
@@ -3485,15 +2893,6 @@ module Aws::ElasticsearchService
3485
2893
  # Container for request parameters to ` ListPackagesForDomain `
3486
2894
  # operation.
3487
2895
  #
3488
- # @note When making an API call, you may pass ListPackagesForDomainRequest
3489
- # data as a hash:
3490
- #
3491
- # {
3492
- # domain_name: "DomainName", # required
3493
- # max_results: 1,
3494
- # next_token: "NextToken",
3495
- # }
3496
- #
3497
2896
  # @!attribute [rw] domain_name
3498
2897
  # The name of the domain for which you want to list associated
3499
2898
  # packages.
@@ -3540,13 +2939,6 @@ module Aws::ElasticsearchService
3540
2939
  # `ARN` for the Elasticsearch domain to which the tags are attached that
3541
2940
  # you want to view are attached.
3542
2941
  #
3543
- # @note When making an API call, you may pass ListTagsRequest
3544
- # data as a hash:
3545
- #
3546
- # {
3547
- # arn: "ARN", # required
3548
- # }
3549
- #
3550
2942
  # @!attribute [rw] arn
3551
2943
  # Specify the `ARN` for the Elasticsearch domain to which the tags are
3552
2944
  # attached that you want to view.
@@ -3575,14 +2967,6 @@ module Aws::ElasticsearchService
3575
2967
  # given Amazon OpenSearch Service domain through the use of an interface
3576
2968
  # VPC endpoint
3577
2969
  #
3578
- # @note When making an API call, you may pass ListVpcEndpointAccessRequest
3579
- # data as a hash:
3580
- #
3581
- # {
3582
- # domain_name: "DomainName", # required
3583
- # next_token: "NextToken",
3584
- # }
3585
- #
3586
2970
  # @!attribute [rw] domain_name
3587
2971
  # The name of the OpenSearch Service domain to retrieve access
3588
2972
  # information for.
@@ -3622,14 +3006,6 @@ module Aws::ElasticsearchService
3622
3006
  # Container for request parameters to the `ListVpcEndpointsForDomain`
3623
3007
  # operation. Specifies the domain whose VPC endpoints will be listed.
3624
3008
  #
3625
- # @note When making an API call, you may pass ListVpcEndpointsForDomainRequest
3626
- # data as a hash:
3627
- #
3628
- # {
3629
- # domain_name: "DomainName", # required
3630
- # next_token: "NextToken",
3631
- # }
3632
- #
3633
3009
  # @!attribute [rw] domain_name
3634
3010
  # Name of the ElasticSearch domain whose VPC endpoints are to be
3635
3011
  # listed.
@@ -3668,13 +3044,6 @@ module Aws::ElasticsearchService
3668
3044
 
3669
3045
  # Container for request parameters to the `ListVpcEndpoints` operation.
3670
3046
  #
3671
- # @note When making an API call, you may pass ListVpcEndpointsRequest
3672
- # data as a hash:
3673
- #
3674
- # {
3675
- # next_token: "NextToken",
3676
- # }
3677
- #
3678
3047
  # @!attribute [rw] next_token
3679
3048
  # Identifier to allow retrieval of paginated results.
3680
3049
  # @return [String]
@@ -3710,14 +3079,6 @@ module Aws::ElasticsearchService
3710
3079
  # * Enabled: Whether the log publishing for given log type is enabled or
3711
3080
  # not
3712
3081
  #
3713
- # @note When making an API call, you may pass LogPublishingOption
3714
- # data as a hash:
3715
- #
3716
- # {
3717
- # cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
3718
- # enabled: false,
3719
- # }
3720
- #
3721
3082
  # @!attribute [rw] cloud_watch_logs_log_group_arn
3722
3083
  # ARN of the Cloudwatch log group to which log needs to be published.
3723
3084
  # @return [String]
@@ -3755,15 +3116,6 @@ module Aws::ElasticsearchService
3755
3116
 
3756
3117
  # Credentials for the master user: username and password, ARN, or both.
3757
3118
  #
3758
- # @note When making an API call, you may pass MasterUserOptions
3759
- # data as a hash:
3760
- #
3761
- # {
3762
- # master_user_arn: "ARN",
3763
- # master_user_name: "Username",
3764
- # master_user_password: "Password",
3765
- # }
3766
- #
3767
3119
  # @!attribute [rw] master_user_arn
3768
3120
  # ARN for the master user (if IAM is enabled).
3769
3121
  # @return [String]
@@ -3788,13 +3140,6 @@ module Aws::ElasticsearchService
3788
3140
 
3789
3141
  # Specifies the node-to-node encryption options.
3790
3142
  #
3791
- # @note When making an API call, you may pass NodeToNodeEncryptionOptions
3792
- # data as a hash:
3793
- #
3794
- # {
3795
- # enabled: false,
3796
- # }
3797
- #
3798
3143
  # @!attribute [rw] enabled
3799
3144
  # Specify true to enable node-to-node encryption.
3800
3145
  # @return [Boolean]
@@ -3980,14 +3325,6 @@ module Aws::ElasticsearchService
3980
3325
  # The S3 location for importing the package specified as `S3BucketName`
3981
3326
  # and `S3Key`
3982
3327
  #
3983
- # @note When making an API call, you may pass PackageSource
3984
- # data as a hash:
3985
- #
3986
- # {
3987
- # s3_bucket_name: "S3BucketName",
3988
- # s3_key: "S3Key",
3989
- # }
3990
- #
3991
3328
  # @!attribute [rw] s3_bucket_name
3992
3329
  # Name of the bucket containing the package.
3993
3330
  # @return [String]
@@ -4028,15 +3365,6 @@ module Aws::ElasticsearchService
4028
3365
  # Container for parameters to
4029
3366
  # `PurchaseReservedElasticsearchInstanceOffering`
4030
3367
  #
4031
- # @note When making an API call, you may pass PurchaseReservedElasticsearchInstanceOfferingRequest
4032
- # data as a hash:
4033
- #
4034
- # {
4035
- # reserved_elasticsearch_instance_offering_id: "GUID", # required
4036
- # reservation_name: "ReservationToken", # required
4037
- # instance_count: 1,
4038
- # }
4039
- #
4040
3368
  # @!attribute [rw] reserved_elasticsearch_instance_offering_id
4041
3369
  # The ID of the reserved Elasticsearch instance offering to purchase.
4042
3370
  # @return [String]
@@ -4097,13 +3425,6 @@ module Aws::ElasticsearchService
4097
3425
  # Container for the parameters to the
4098
3426
  # `RejectInboundCrossClusterSearchConnection` operation.
4099
3427
  #
4100
- # @note When making an API call, you may pass RejectInboundCrossClusterSearchConnectionRequest
4101
- # data as a hash:
4102
- #
4103
- # {
4104
- # cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
4105
- # }
4106
- #
4107
3428
  # @!attribute [rw] cross_cluster_search_connection_id
4108
3429
  # The id of the inbound connection that you want to reject.
4109
3430
  # @return [String]
@@ -4132,14 +3453,6 @@ module Aws::ElasticsearchService
4132
3453
  # the `ARN` for the Elasticsearch domain from which you want to remove
4133
3454
  # the specified `TagKey`.
4134
3455
  #
4135
- # @note When making an API call, you may pass RemoveTagsRequest
4136
- # data as a hash:
4137
- #
4138
- # {
4139
- # arn: "ARN", # required
4140
- # tag_keys: ["String"], # required
4141
- # }
4142
- #
4143
3456
  # @!attribute [rw] arn
4144
3457
  # Specifies the `ARN` for the Elasticsearch domain from which you want
4145
3458
  # to delete the specified tags.
@@ -4300,14 +3613,6 @@ module Aws::ElasticsearchService
4300
3613
  # Revokes access to an Amazon OpenSearch Service domain that was
4301
3614
  # provided through an interface VPC endpoint.
4302
3615
  #
4303
- # @note When making an API call, you may pass RevokeVpcEndpointAccessRequest
4304
- # data as a hash:
4305
- #
4306
- # {
4307
- # domain_name: "DomainName", # required
4308
- # account: "AWSAccount", # required
4309
- # }
4310
- #
4311
3616
  # @!attribute [rw] domain_name
4312
3617
  # The name of the OpenSearch Service domain.
4313
3618
  # @return [String]
@@ -4330,14 +3635,6 @@ module Aws::ElasticsearchService
4330
3635
 
4331
3636
  # Specifies the SAML Identity Provider's information.
4332
3637
  #
4333
- # @note When making an API call, you may pass SAMLIdp
4334
- # data as a hash:
4335
- #
4336
- # {
4337
- # metadata_content: "SAMLMetadata", # required
4338
- # entity_id: "SAMLEntityId", # required
4339
- # }
4340
- #
4341
3638
  # @!attribute [rw] metadata_content
4342
3639
  # The Metadata of the SAML application in xml format.
4343
3640
  # @return [String]
@@ -4355,22 +3652,6 @@ module Aws::ElasticsearchService
4355
3652
 
4356
3653
  # Specifies the SAML application configuration for the domain.
4357
3654
  #
4358
- # @note When making an API call, you may pass SAMLOptionsInput
4359
- # data as a hash:
4360
- #
4361
- # {
4362
- # enabled: false,
4363
- # idp: {
4364
- # metadata_content: "SAMLMetadata", # required
4365
- # entity_id: "SAMLEntityId", # required
4366
- # },
4367
- # master_user_name: "Username",
4368
- # master_backend_role: "BackendRole",
4369
- # subject_key: "String",
4370
- # roles_key: "String",
4371
- # session_timeout_minutes: 1,
4372
- # }
4373
- #
4374
3655
  # @!attribute [rw] enabled
4375
3656
  # True if SAML is enabled.
4376
3657
  # @return [Boolean]
@@ -4543,13 +3824,6 @@ module Aws::ElasticsearchService
4543
3824
  # automated snapshot of the specified Elasticsearch domain. Default
4544
3825
  # value is `0` hours.
4545
3826
  #
4546
- # @note When making an API call, you may pass SnapshotOptions
4547
- # data as a hash:
4548
- #
4549
- # {
4550
- # automated_snapshot_start_hour: 1,
4551
- # }
4552
- #
4553
3827
  # @!attribute [rw] automated_snapshot_start_hour
4554
3828
  # Specifies the time, in UTC format, when the service takes a daily
4555
3829
  # automated snapshot of the specified Elasticsearch domain. Default
@@ -4585,13 +3859,6 @@ module Aws::ElasticsearchService
4585
3859
  # name of the Elasticsearch domain that you wish to schedule a service
4586
3860
  # software update on.
4587
3861
  #
4588
- # @note When making an API call, you may pass StartElasticsearchServiceSoftwareUpdateRequest
4589
- # data as a hash:
4590
- #
4591
- # {
4592
- # domain_name: "DomainName", # required
4593
- # }
4594
- #
4595
3862
  # @!attribute [rw] domain_name
4596
3863
  # The name of the domain that you want to update to the latest service
4597
3864
  # software.
@@ -4675,14 +3942,6 @@ module Aws::ElasticsearchService
4675
3942
 
4676
3943
  # Specifies a key value pair for a resource tag.
4677
3944
  #
4678
- # @note When making an API call, you may pass Tag
4679
- # data as a hash:
4680
- #
4681
- # {
4682
- # key: "TagKey", # required
4683
- # value: "TagValue", # required
4684
- # }
4685
- #
4686
3945
  # @!attribute [rw] key
4687
3946
  # Specifies the `TagKey`, the name of the tag. Tag keys must be unique
4688
3947
  # for the Elasticsearch domain to which they are attached.
@@ -4706,111 +3965,6 @@ module Aws::ElasticsearchService
4706
3965
  # operation. Specifies the type and number of instances in the domain
4707
3966
  # cluster.
4708
3967
  #
4709
- # @note When making an API call, you may pass UpdateElasticsearchDomainConfigRequest
4710
- # data as a hash:
4711
- #
4712
- # {
4713
- # domain_name: "DomainName", # required
4714
- # elasticsearch_cluster_config: {
4715
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
4716
- # instance_count: 1,
4717
- # dedicated_master_enabled: false,
4718
- # zone_awareness_enabled: false,
4719
- # zone_awareness_config: {
4720
- # availability_zone_count: 1,
4721
- # },
4722
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
4723
- # dedicated_master_count: 1,
4724
- # warm_enabled: false,
4725
- # warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
4726
- # warm_count: 1,
4727
- # cold_storage_options: {
4728
- # enabled: false, # required
4729
- # },
4730
- # },
4731
- # ebs_options: {
4732
- # ebs_enabled: false,
4733
- # volume_type: "standard", # accepts standard, gp2, io1, gp3
4734
- # volume_size: 1,
4735
- # iops: 1,
4736
- # throughput: 1,
4737
- # },
4738
- # snapshot_options: {
4739
- # automated_snapshot_start_hour: 1,
4740
- # },
4741
- # vpc_options: {
4742
- # subnet_ids: ["String"],
4743
- # security_group_ids: ["String"],
4744
- # },
4745
- # cognito_options: {
4746
- # enabled: false,
4747
- # user_pool_id: "UserPoolId",
4748
- # identity_pool_id: "IdentityPoolId",
4749
- # role_arn: "RoleArn",
4750
- # },
4751
- # advanced_options: {
4752
- # "String" => "String",
4753
- # },
4754
- # access_policies: "PolicyDocument",
4755
- # log_publishing_options: {
4756
- # "INDEX_SLOW_LOGS" => {
4757
- # cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
4758
- # enabled: false,
4759
- # },
4760
- # },
4761
- # domain_endpoint_options: {
4762
- # enforce_https: false,
4763
- # tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
4764
- # custom_endpoint_enabled: false,
4765
- # custom_endpoint: "DomainNameFqdn",
4766
- # custom_endpoint_certificate_arn: "ARN",
4767
- # },
4768
- # advanced_security_options: {
4769
- # enabled: false,
4770
- # internal_user_database_enabled: false,
4771
- # master_user_options: {
4772
- # master_user_arn: "ARN",
4773
- # master_user_name: "Username",
4774
- # master_user_password: "Password",
4775
- # },
4776
- # saml_options: {
4777
- # enabled: false,
4778
- # idp: {
4779
- # metadata_content: "SAMLMetadata", # required
4780
- # entity_id: "SAMLEntityId", # required
4781
- # },
4782
- # master_user_name: "Username",
4783
- # master_backend_role: "BackendRole",
4784
- # subject_key: "String",
4785
- # roles_key: "String",
4786
- # session_timeout_minutes: 1,
4787
- # },
4788
- # anonymous_auth_enabled: false,
4789
- # },
4790
- # node_to_node_encryption_options: {
4791
- # enabled: false,
4792
- # },
4793
- # encryption_at_rest_options: {
4794
- # enabled: false,
4795
- # kms_key_id: "KmsKeyId",
4796
- # },
4797
- # auto_tune_options: {
4798
- # desired_state: "ENABLED", # accepts ENABLED, DISABLED
4799
- # rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
4800
- # maintenance_schedules: [
4801
- # {
4802
- # start_at: Time.now,
4803
- # duration: {
4804
- # value: 1,
4805
- # unit: "HOURS", # accepts HOURS
4806
- # },
4807
- # cron_expression_for_recurrence: "String",
4808
- # },
4809
- # ],
4810
- # },
4811
- # dry_run: false,
4812
- # }
4813
- #
4814
3968
  # @!attribute [rw] domain_name
4815
3969
  # The name of the Elasticsearch domain that you are updating.
4816
3970
  # @return [String]
@@ -4939,19 +4093,6 @@ module Aws::ElasticsearchService
4939
4093
 
4940
4094
  # Container for request parameters to ` UpdatePackage ` operation.
4941
4095
  #
4942
- # @note When making an API call, you may pass UpdatePackageRequest
4943
- # data as a hash:
4944
- #
4945
- # {
4946
- # package_id: "PackageID", # required
4947
- # package_source: { # required
4948
- # s3_bucket_name: "S3BucketName",
4949
- # s3_key: "S3Key",
4950
- # },
4951
- # package_description: "PackageDescription",
4952
- # commit_message: "CommitMessage",
4953
- # }
4954
- #
4955
4096
  # @!attribute [rw] package_id
4956
4097
  # Unique identifier for the package.
4957
4098
  # @return [String]
@@ -4993,17 +4134,6 @@ module Aws::ElasticsearchService
4993
4134
 
4994
4135
  # Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
4995
4136
  #
4996
- # @note When making an API call, you may pass UpdateVpcEndpointRequest
4997
- # data as a hash:
4998
- #
4999
- # {
5000
- # vpc_endpoint_id: "VpcEndpointId", # required
5001
- # vpc_options: { # required
5002
- # subnet_ids: ["String"],
5003
- # security_group_ids: ["String"],
5004
- # },
5005
- # }
5006
- #
5007
4137
  # @!attribute [rw] vpc_endpoint_id
5008
4138
  # Unique identifier of the VPC endpoint to be updated.
5009
4139
  # @return [String]
@@ -5035,15 +4165,6 @@ module Aws::ElasticsearchService
5035
4165
  # Container for request parameters to ` UpgradeElasticsearchDomain `
5036
4166
  # operation.
5037
4167
  #
5038
- # @note When making an API call, you may pass UpgradeElasticsearchDomainRequest
5039
- # data as a hash:
5040
- #
5041
- # {
5042
- # domain_name: "DomainName", # required
5043
- # target_version: "ElasticsearchVersionString", # required
5044
- # perform_check_only: false,
5045
- # }
5046
- #
5047
4168
  # @!attribute [rw] domain_name
5048
4169
  # The name of an Elasticsearch domain. Domain names are unique across
5049
4170
  # the domains owned by an account within an AWS region. Domain names
@@ -5236,14 +4357,6 @@ module Aws::ElasticsearchService
5236
4357
  #
5237
4358
  # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html
5238
4359
  #
5239
- # @note When making an API call, you may pass VPCOptions
5240
- # data as a hash:
5241
- #
5242
- # {
5243
- # subnet_ids: ["String"],
5244
- # security_group_ids: ["String"],
5245
- # }
5246
- #
5247
4360
  # @!attribute [rw] subnet_ids
5248
4361
  # Specifies the subnets for VPC endpoint.
5249
4362
  # @return [Array<String>]
@@ -5359,13 +4472,6 @@ module Aws::ElasticsearchService
5359
4472
  # Specifies the zone awareness configuration for the domain cluster,
5360
4473
  # such as the number of availability zones.
5361
4474
  #
5362
- # @note When making an API call, you may pass ZoneAwarenessConfig
5363
- # data as a hash:
5364
- #
5365
- # {
5366
- # availability_zone_count: 1,
5367
- # }
5368
- #
5369
4475
  # @!attribute [rw] availability_zone_count
5370
4476
  # An integer value to indicate the number of availability zones for a
5371
4477
  # domain when zone awareness is enabled. This should be equal to