aws-sdk-opensearchservice 1.26.0 → 1.35.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +45 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +437 -23
- data/lib/aws-sdk-opensearchservice/client_api.rb +271 -0
- data/lib/aws-sdk-opensearchservice/endpoint_provider.rb +10 -1
- data/lib/aws-sdk-opensearchservice/endpoints.rb +112 -0
- data/lib/aws-sdk-opensearchservice/plugins/endpoints.rb +19 -2
- data/lib/aws-sdk-opensearchservice/types.rb +591 -15
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- metadata +5 -5
@@ -96,6 +96,49 @@ module Aws::OpenSearchService
|
|
96
96
|
include Aws::Structure
|
97
97
|
end
|
98
98
|
|
99
|
+
# Container for the parameters to the `AddDataSource` operation.
|
100
|
+
#
|
101
|
+
# @!attribute [rw] domain_name
|
102
|
+
# The name of the domain to add the data source to.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] name
|
106
|
+
# A name for the data source.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] data_source_type
|
110
|
+
# The type of data source.
|
111
|
+
# @return [Types::DataSourceType]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] description
|
114
|
+
# A description of the data source.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSourceRequest AWS API Documentation
|
118
|
+
#
|
119
|
+
class AddDataSourceRequest < Struct.new(
|
120
|
+
:domain_name,
|
121
|
+
:name,
|
122
|
+
:data_source_type,
|
123
|
+
:description)
|
124
|
+
SENSITIVE = []
|
125
|
+
include Aws::Structure
|
126
|
+
end
|
127
|
+
|
128
|
+
# The result of an `AddDataSource` operation.
|
129
|
+
#
|
130
|
+
# @!attribute [rw] message
|
131
|
+
# A message associated with creation of the data source.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSourceResponse AWS API Documentation
|
135
|
+
#
|
136
|
+
class AddDataSourceResponse < Struct.new(
|
137
|
+
:message)
|
138
|
+
SENSITIVE = []
|
139
|
+
include Aws::Structure
|
140
|
+
end
|
141
|
+
|
99
142
|
# Container for the parameters to the `AddTags` operation. Specifies the
|
100
143
|
# tags to attach to the domain.
|
101
144
|
#
|
@@ -861,8 +904,8 @@ module Aws::OpenSearchService
|
|
861
904
|
# @return [String]
|
862
905
|
#
|
863
906
|
# @!attribute [rw] instance_count
|
864
|
-
# Number of
|
865
|
-
#
|
907
|
+
# Number of data nodes in the cluster. This number must be greater
|
908
|
+
# than 1, otherwise you receive a validation exception.
|
866
909
|
# @return [Integer]
|
867
910
|
#
|
868
911
|
# @!attribute [rw] dedicated_master_enabled
|
@@ -1121,6 +1164,14 @@ module Aws::OpenSearchService
|
|
1121
1164
|
# access policies for the new domain.
|
1122
1165
|
# @return [String]
|
1123
1166
|
#
|
1167
|
+
# @!attribute [rw] ip_address_type
|
1168
|
+
# Specify either dual stack or IPv4 as your IP address type. Dual
|
1169
|
+
# stack allows you to share domain resources across IPv4 and IPv6
|
1170
|
+
# address types, and is the recommended option. If you set your IP
|
1171
|
+
# address type to dual stack, you can't change your address type
|
1172
|
+
# later.
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1124
1175
|
# @!attribute [rw] snapshot_options
|
1125
1176
|
# DEPRECATED. Container for the parameters required to configure
|
1126
1177
|
# automated snapshots of domain indexes.
|
@@ -1231,6 +1282,7 @@ module Aws::OpenSearchService
|
|
1231
1282
|
:cluster_config,
|
1232
1283
|
:ebs_options,
|
1233
1284
|
:access_policies,
|
1285
|
+
:ip_address_type,
|
1234
1286
|
:snapshot_options,
|
1235
1287
|
:vpc_options,
|
1236
1288
|
:cognito_options,
|
@@ -1423,10 +1475,13 @@ module Aws::OpenSearchService
|
|
1423
1475
|
include Aws::Structure
|
1424
1476
|
end
|
1425
1477
|
|
1426
|
-
# Cross
|
1478
|
+
# Cross-cluster search specific connection properties.
|
1427
1479
|
#
|
1428
1480
|
# @!attribute [rw] skip_unavailable
|
1429
|
-
#
|
1481
|
+
# The status of the `SkipUnavailable` setting for the outbound
|
1482
|
+
# connection. This feature allows you to specify some clusters as
|
1483
|
+
# optional and ensure that your cross-cluster queries return partial
|
1484
|
+
# results despite failures on one or more remote clusters.
|
1430
1485
|
# @return [String]
|
1431
1486
|
#
|
1432
1487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CrossClusterSearchConnectionProperties AWS API Documentation
|
@@ -1437,6 +1492,86 @@ module Aws::OpenSearchService
|
|
1437
1492
|
include Aws::Structure
|
1438
1493
|
end
|
1439
1494
|
|
1495
|
+
# Details about a direct-query data source.
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] data_source_type
|
1498
|
+
# The type of data source.
|
1499
|
+
# @return [Types::DataSourceType]
|
1500
|
+
#
|
1501
|
+
# @!attribute [rw] name
|
1502
|
+
# The name of the data source.
|
1503
|
+
# @return [String]
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] description
|
1506
|
+
# A description of the data source.
|
1507
|
+
# @return [String]
|
1508
|
+
#
|
1509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceDetails AWS API Documentation
|
1510
|
+
#
|
1511
|
+
class DataSourceDetails < Struct.new(
|
1512
|
+
:data_source_type,
|
1513
|
+
:name,
|
1514
|
+
:description)
|
1515
|
+
SENSITIVE = []
|
1516
|
+
include Aws::Structure
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# The type of data source.
|
1520
|
+
#
|
1521
|
+
# @note DataSourceType is a union - when making an API calls you must set exactly one of the members.
|
1522
|
+
#
|
1523
|
+
# @note DataSourceType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataSourceType corresponding to the set member.
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] s3_glue_data_catalog
|
1526
|
+
# An Amazon S3 data source.
|
1527
|
+
# @return [Types::S3GlueDataCatalog]
|
1528
|
+
#
|
1529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceType AWS API Documentation
|
1530
|
+
#
|
1531
|
+
class DataSourceType < Struct.new(
|
1532
|
+
:s3_glue_data_catalog,
|
1533
|
+
:unknown)
|
1534
|
+
SENSITIVE = []
|
1535
|
+
include Aws::Structure
|
1536
|
+
include Aws::Structure::Union
|
1537
|
+
|
1538
|
+
class S3GlueDataCatalog < DataSourceType; end
|
1539
|
+
class Unknown < DataSourceType; end
|
1540
|
+
end
|
1541
|
+
|
1542
|
+
# Container for the parameters to the `DeleteDataSource` operation.
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] domain_name
|
1545
|
+
# The name of the domain.
|
1546
|
+
# @return [String]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] name
|
1549
|
+
# The name of the data source to delete.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceRequest AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class DeleteDataSourceRequest < Struct.new(
|
1555
|
+
:domain_name,
|
1556
|
+
:name)
|
1557
|
+
SENSITIVE = []
|
1558
|
+
include Aws::Structure
|
1559
|
+
end
|
1560
|
+
|
1561
|
+
# The result of a `GetDataSource` operation.
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] message
|
1564
|
+
# A message associated with deletion of the data source.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceResponse AWS API Documentation
|
1568
|
+
#
|
1569
|
+
class DeleteDataSourceResponse < Struct.new(
|
1570
|
+
:message)
|
1571
|
+
SENSITIVE = []
|
1572
|
+
include Aws::Structure
|
1573
|
+
end
|
1574
|
+
|
1440
1575
|
# Container for the parameters to the `DeleteDomain` operation.
|
1441
1576
|
#
|
1442
1577
|
# @!attribute [rw] domain_name
|
@@ -1892,8 +2027,7 @@ module Aws::OpenSearchService
|
|
1892
2027
|
#
|
1893
2028
|
# @!attribute [rw] domain_names
|
1894
2029
|
# Array of OpenSearch Service domain names that you want information
|
1895
|
-
# about.
|
1896
|
-
# information about all domains owned by the account.
|
2030
|
+
# about. You must specify at least one domain name.
|
1897
2031
|
# @return [Array<String>]
|
1898
2032
|
#
|
1899
2033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainsRequest AWS API Documentation
|
@@ -2383,6 +2517,13 @@ module Aws::OpenSearchService
|
|
2383
2517
|
# Specifies the access policies for the domain.
|
2384
2518
|
# @return [Types::AccessPoliciesStatus]
|
2385
2519
|
#
|
2520
|
+
# @!attribute [rw] ip_address_type
|
2521
|
+
# Choose either dual stack or IPv4 as your IP address type. Dual stack
|
2522
|
+
# allows you to share domain resources across IPv4 and IPv6 address
|
2523
|
+
# types, and is the recommended option. If you set your IP address
|
2524
|
+
# type to dual stack, you can't change your address type later.
|
2525
|
+
# @return [Types::IPAddressTypeStatus]
|
2526
|
+
#
|
2386
2527
|
# @!attribute [rw] snapshot_options
|
2387
2528
|
# DEPRECATED. Container for parameters required to configure automated
|
2388
2529
|
# snapshots of domain indexes.
|
@@ -2451,6 +2592,7 @@ module Aws::OpenSearchService
|
|
2451
2592
|
:cluster_config,
|
2452
2593
|
:ebs_options,
|
2453
2594
|
:access_policies,
|
2595
|
+
:ip_address_type,
|
2454
2596
|
:snapshot_options,
|
2455
2597
|
:vpc_options,
|
2456
2598
|
:cognito_options,
|
@@ -2477,15 +2619,17 @@ module Aws::OpenSearchService
|
|
2477
2619
|
#
|
2478
2620
|
# @!attribute [rw] tls_security_policy
|
2479
2621
|
# Specify the TLS security policy to apply to the HTTPS endpoint of
|
2480
|
-
# the domain.
|
2622
|
+
# the domain. The policy can be one of the following values:
|
2481
2623
|
#
|
2482
|
-
#
|
2624
|
+
# * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports
|
2625
|
+
# TLS version 1.0 to TLS version 1.2
|
2483
2626
|
#
|
2484
|
-
# * **Policy-Min-TLS-1-
|
2485
|
-
# TLS version 1.0 and higher.
|
2486
|
-
#
|
2487
|
-
# * **Policy-Min-TLS-1-2-2019-07:** TLS security policy which supports
|
2627
|
+
# * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports
|
2488
2628
|
# only TLS version 1.2
|
2629
|
+
#
|
2630
|
+
# * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that
|
2631
|
+
# supports TLS version 1.2 to TLS version 1.3 with perfect forward
|
2632
|
+
# secrecy cipher suites
|
2489
2633
|
# @return [String]
|
2490
2634
|
#
|
2491
2635
|
# @!attribute [rw] custom_endpoint_enabled
|
@@ -2567,6 +2711,55 @@ module Aws::OpenSearchService
|
|
2567
2711
|
include Aws::Structure
|
2568
2712
|
end
|
2569
2713
|
|
2714
|
+
# Container for the domain maintenance details.
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] maintenance_id
|
2717
|
+
# The ID of the requested action.
|
2718
|
+
# @return [String]
|
2719
|
+
#
|
2720
|
+
# @!attribute [rw] domain_name
|
2721
|
+
# The name of the domain.
|
2722
|
+
# @return [String]
|
2723
|
+
#
|
2724
|
+
# @!attribute [rw] action
|
2725
|
+
# The name of the action.
|
2726
|
+
# @return [String]
|
2727
|
+
#
|
2728
|
+
# @!attribute [rw] node_id
|
2729
|
+
# The ID of the data node.
|
2730
|
+
# @return [String]
|
2731
|
+
#
|
2732
|
+
# @!attribute [rw] status
|
2733
|
+
# The status of the action.
|
2734
|
+
# @return [String]
|
2735
|
+
#
|
2736
|
+
# @!attribute [rw] status_message
|
2737
|
+
# The status message for the action.
|
2738
|
+
# @return [String]
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] created_at
|
2741
|
+
# The time at which the action was created.
|
2742
|
+
# @return [Time]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] updated_at
|
2745
|
+
# The time at which the action was updated.
|
2746
|
+
# @return [Time]
|
2747
|
+
#
|
2748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainMaintenanceDetails AWS API Documentation
|
2749
|
+
#
|
2750
|
+
class DomainMaintenanceDetails < Struct.new(
|
2751
|
+
:maintenance_id,
|
2752
|
+
:domain_name,
|
2753
|
+
:action,
|
2754
|
+
:node_id,
|
2755
|
+
:status,
|
2756
|
+
:status_message,
|
2757
|
+
:created_at,
|
2758
|
+
:updated_at)
|
2759
|
+
SENSITIVE = []
|
2760
|
+
include Aws::Structure
|
2761
|
+
end
|
2762
|
+
|
2570
2763
|
# Container for information about nodes on the domain.
|
2571
2764
|
#
|
2572
2765
|
# @!attribute [rw] node_id
|
@@ -2717,9 +2910,16 @@ module Aws::OpenSearchService
|
|
2717
2910
|
# upload requests to the domain.
|
2718
2911
|
# @return [String]
|
2719
2912
|
#
|
2913
|
+
# @!attribute [rw] endpoint_v2
|
2914
|
+
# If `IPAddressType` to set to `dualstack`, a version 2 domain
|
2915
|
+
# endpoint is provisioned. This endpoint functions like a normal
|
2916
|
+
# endpoint, except that it works with both IPv4 and IPv6 IP addresses.
|
2917
|
+
# Normal endpoints work only with IPv4 IP addresses.
|
2918
|
+
# @return [String]
|
2919
|
+
#
|
2720
2920
|
# @!attribute [rw] endpoints
|
2721
2921
|
# The key-value pair that exists if the OpenSearch Service domain uses
|
2722
|
-
# VPC endpoints
|
2922
|
+
# VPC endpoints. Example `key, value`:
|
2723
2923
|
# `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.
|
2724
2924
|
# @return [Hash<String,String>]
|
2725
2925
|
#
|
@@ -2753,6 +2953,10 @@ module Aws::OpenSearchService
|
|
2753
2953
|
# access policies for the domain.
|
2754
2954
|
# @return [String]
|
2755
2955
|
#
|
2956
|
+
# @!attribute [rw] ip_address_type
|
2957
|
+
# The type of IP addresses supported by the endpoint for the domain.
|
2958
|
+
# @return [String]
|
2959
|
+
#
|
2756
2960
|
# @!attribute [rw] snapshot_options
|
2757
2961
|
# DEPRECATED. Container for parameters required to configure automated
|
2758
2962
|
# snapshots of domain indexes.
|
@@ -2822,6 +3026,7 @@ module Aws::OpenSearchService
|
|
2822
3026
|
:created,
|
2823
3027
|
:deleted,
|
2824
3028
|
:endpoint,
|
3029
|
+
:endpoint_v2,
|
2825
3030
|
:endpoints,
|
2826
3031
|
:processing,
|
2827
3032
|
:upgrade_processing,
|
@@ -2829,6 +3034,7 @@ module Aws::OpenSearchService
|
|
2829
3034
|
:cluster_config,
|
2830
3035
|
:ebs_options,
|
2831
3036
|
:access_policies,
|
3037
|
+
:ip_address_type,
|
2832
3038
|
:snapshot_options,
|
2833
3039
|
:vpc_options,
|
2834
3040
|
:cognito_options,
|
@@ -3125,6 +3331,109 @@ module Aws::OpenSearchService
|
|
3125
3331
|
include Aws::Structure
|
3126
3332
|
end
|
3127
3333
|
|
3334
|
+
# Container for the parameters to the `GetDataSource` operation.
|
3335
|
+
#
|
3336
|
+
# @!attribute [rw] domain_name
|
3337
|
+
# The name of the domain.
|
3338
|
+
# @return [String]
|
3339
|
+
#
|
3340
|
+
# @!attribute [rw] name
|
3341
|
+
# The name of the data source to get information about.
|
3342
|
+
# @return [String]
|
3343
|
+
#
|
3344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceRequest AWS API Documentation
|
3345
|
+
#
|
3346
|
+
class GetDataSourceRequest < Struct.new(
|
3347
|
+
:domain_name,
|
3348
|
+
:name)
|
3349
|
+
SENSITIVE = []
|
3350
|
+
include Aws::Structure
|
3351
|
+
end
|
3352
|
+
|
3353
|
+
# The result of a `GetDataSource` operation.
|
3354
|
+
#
|
3355
|
+
# @!attribute [rw] data_source_type
|
3356
|
+
# The type of data source.
|
3357
|
+
# @return [Types::DataSourceType]
|
3358
|
+
#
|
3359
|
+
# @!attribute [rw] name
|
3360
|
+
# The name of the data source.
|
3361
|
+
# @return [String]
|
3362
|
+
#
|
3363
|
+
# @!attribute [rw] description
|
3364
|
+
# A description of the data source.
|
3365
|
+
# @return [String]
|
3366
|
+
#
|
3367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceResponse AWS API Documentation
|
3368
|
+
#
|
3369
|
+
class GetDataSourceResponse < Struct.new(
|
3370
|
+
:data_source_type,
|
3371
|
+
:name,
|
3372
|
+
:description)
|
3373
|
+
SENSITIVE = []
|
3374
|
+
include Aws::Structure
|
3375
|
+
end
|
3376
|
+
|
3377
|
+
# Container for the parameters to the `GetDomainMaintenanceStatus`
|
3378
|
+
# operation.
|
3379
|
+
#
|
3380
|
+
# @!attribute [rw] domain_name
|
3381
|
+
# The name of the domain.
|
3382
|
+
# @return [String]
|
3383
|
+
#
|
3384
|
+
# @!attribute [rw] maintenance_id
|
3385
|
+
# The request ID of the maintenance action.
|
3386
|
+
# @return [String]
|
3387
|
+
#
|
3388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusRequest AWS API Documentation
|
3389
|
+
#
|
3390
|
+
class GetDomainMaintenanceStatusRequest < Struct.new(
|
3391
|
+
:domain_name,
|
3392
|
+
:maintenance_id)
|
3393
|
+
SENSITIVE = []
|
3394
|
+
include Aws::Structure
|
3395
|
+
end
|
3396
|
+
|
3397
|
+
# The result of a `GetDomainMaintenanceStatus` request that information
|
3398
|
+
# about the requested action.
|
3399
|
+
#
|
3400
|
+
# @!attribute [rw] status
|
3401
|
+
# The status of the maintenance action.
|
3402
|
+
# @return [String]
|
3403
|
+
#
|
3404
|
+
# @!attribute [rw] status_message
|
3405
|
+
# The status message of the maintenance action.
|
3406
|
+
# @return [String]
|
3407
|
+
#
|
3408
|
+
# @!attribute [rw] node_id
|
3409
|
+
# The node ID of the maintenance action.
|
3410
|
+
# @return [String]
|
3411
|
+
#
|
3412
|
+
# @!attribute [rw] action
|
3413
|
+
# The action name.
|
3414
|
+
# @return [String]
|
3415
|
+
#
|
3416
|
+
# @!attribute [rw] created_at
|
3417
|
+
# The time at which the action was created.
|
3418
|
+
# @return [Time]
|
3419
|
+
#
|
3420
|
+
# @!attribute [rw] updated_at
|
3421
|
+
# The time at which the action was updated.
|
3422
|
+
# @return [Time]
|
3423
|
+
#
|
3424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusResponse AWS API Documentation
|
3425
|
+
#
|
3426
|
+
class GetDomainMaintenanceStatusResponse < Struct.new(
|
3427
|
+
:status,
|
3428
|
+
:status_message,
|
3429
|
+
:node_id,
|
3430
|
+
:action,
|
3431
|
+
:created_at,
|
3432
|
+
:updated_at)
|
3433
|
+
SENSITIVE = []
|
3434
|
+
include Aws::Structure
|
3435
|
+
end
|
3436
|
+
|
3128
3437
|
# Container for the request parameters to the `GetPackageVersionHistory`
|
3129
3438
|
# operation.
|
3130
3439
|
#
|
@@ -3277,6 +3586,25 @@ module Aws::OpenSearchService
|
|
3277
3586
|
include Aws::Structure
|
3278
3587
|
end
|
3279
3588
|
|
3589
|
+
# The IP address type status for the domain.
|
3590
|
+
#
|
3591
|
+
# @!attribute [rw] options
|
3592
|
+
# The IP address options for the domain.
|
3593
|
+
# @return [String]
|
3594
|
+
#
|
3595
|
+
# @!attribute [rw] status
|
3596
|
+
# Provides the current status of an entity.
|
3597
|
+
# @return [Types::OptionStatus]
|
3598
|
+
#
|
3599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IPAddressTypeStatus AWS API Documentation
|
3600
|
+
#
|
3601
|
+
class IPAddressTypeStatus < Struct.new(
|
3602
|
+
:options,
|
3603
|
+
:status)
|
3604
|
+
SENSITIVE = []
|
3605
|
+
include Aws::Structure
|
3606
|
+
end
|
3607
|
+
|
3280
3608
|
# Describes an inbound cross-cluster connection for Amazon OpenSearch
|
3281
3609
|
# Service. For more information, see [Cross-cluster search for Amazon
|
3282
3610
|
# OpenSearch Service][1].
|
@@ -3499,6 +3827,96 @@ module Aws::OpenSearchService
|
|
3499
3827
|
include Aws::Structure
|
3500
3828
|
end
|
3501
3829
|
|
3830
|
+
# Container for the parameters to the `ListDataSources` operation.
|
3831
|
+
#
|
3832
|
+
# @!attribute [rw] domain_name
|
3833
|
+
# The name of the domain.
|
3834
|
+
# @return [String]
|
3835
|
+
#
|
3836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesRequest AWS API Documentation
|
3837
|
+
#
|
3838
|
+
class ListDataSourcesRequest < Struct.new(
|
3839
|
+
:domain_name)
|
3840
|
+
SENSITIVE = []
|
3841
|
+
include Aws::Structure
|
3842
|
+
end
|
3843
|
+
|
3844
|
+
# The result of a `ListDataSources` operation.
|
3845
|
+
#
|
3846
|
+
# @!attribute [rw] data_sources
|
3847
|
+
# A list of data sources associated with specified domain.
|
3848
|
+
# @return [Array<Types::DataSourceDetails>]
|
3849
|
+
#
|
3850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesResponse AWS API Documentation
|
3851
|
+
#
|
3852
|
+
class ListDataSourcesResponse < Struct.new(
|
3853
|
+
:data_sources)
|
3854
|
+
SENSITIVE = []
|
3855
|
+
include Aws::Structure
|
3856
|
+
end
|
3857
|
+
|
3858
|
+
# Container for the parameters to the `ListDomainMaintenances`
|
3859
|
+
# operation.
|
3860
|
+
#
|
3861
|
+
# @!attribute [rw] domain_name
|
3862
|
+
# The name of the domain.
|
3863
|
+
# @return [String]
|
3864
|
+
#
|
3865
|
+
# @!attribute [rw] action
|
3866
|
+
# The name of the action.
|
3867
|
+
# @return [String]
|
3868
|
+
#
|
3869
|
+
# @!attribute [rw] status
|
3870
|
+
# The status of the action.
|
3871
|
+
# @return [String]
|
3872
|
+
#
|
3873
|
+
# @!attribute [rw] max_results
|
3874
|
+
# An optional parameter that specifies the maximum number of results
|
3875
|
+
# to return. You can use `nextToken` to get the next page of results.
|
3876
|
+
# @return [Integer]
|
3877
|
+
#
|
3878
|
+
# @!attribute [rw] next_token
|
3879
|
+
# If your initial `ListDomainMaintenances` operation returns a
|
3880
|
+
# `nextToken`, include the returned `nextToken` in subsequent
|
3881
|
+
# `ListDomainMaintenances` operations, which returns results in the
|
3882
|
+
# next page.
|
3883
|
+
# @return [String]
|
3884
|
+
#
|
3885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesRequest AWS API Documentation
|
3886
|
+
#
|
3887
|
+
class ListDomainMaintenancesRequest < Struct.new(
|
3888
|
+
:domain_name,
|
3889
|
+
:action,
|
3890
|
+
:status,
|
3891
|
+
:max_results,
|
3892
|
+
:next_token)
|
3893
|
+
SENSITIVE = []
|
3894
|
+
include Aws::Structure
|
3895
|
+
end
|
3896
|
+
|
3897
|
+
# The result of a `ListDomainMaintenances` request that contains
|
3898
|
+
# information about the requested actions.
|
3899
|
+
#
|
3900
|
+
# @!attribute [rw] domain_maintenances
|
3901
|
+
# A list of the submitted maintenance actions.
|
3902
|
+
# @return [Array<Types::DomainMaintenanceDetails>]
|
3903
|
+
#
|
3904
|
+
# @!attribute [rw] next_token
|
3905
|
+
# When `nextToken` is returned, there are more results available. The
|
3906
|
+
# value of `nextToken` is a unique pagination token for each page.
|
3907
|
+
# Make the call again using the returned token to retrieve the next
|
3908
|
+
# page.
|
3909
|
+
# @return [String]
|
3910
|
+
#
|
3911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesResponse AWS API Documentation
|
3912
|
+
#
|
3913
|
+
class ListDomainMaintenancesResponse < Struct.new(
|
3914
|
+
:domain_maintenances,
|
3915
|
+
:next_token)
|
3916
|
+
SENSITIVE = []
|
3917
|
+
include Aws::Structure
|
3918
|
+
end
|
3919
|
+
|
3502
3920
|
# Container for the parameters to the `ListDomainNames` operation.
|
3503
3921
|
#
|
3504
3922
|
# @!attribute [rw] engine_type
|
@@ -4311,6 +4729,17 @@ module Aws::OpenSearchService
|
|
4311
4729
|
# otherwise.
|
4312
4730
|
# @return [Types::ErrorDetails]
|
4313
4731
|
#
|
4732
|
+
# @!attribute [rw] engine_version
|
4733
|
+
# Version of OpenSearch or Elasticsearch, in the format
|
4734
|
+
# Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
|
4735
|
+
# version of OpenSearch.
|
4736
|
+
# @return [String]
|
4737
|
+
#
|
4738
|
+
# @!attribute [rw] available_plugin_properties
|
4739
|
+
# If the package is a `ZIP-PLUGIN` package, additional information
|
4740
|
+
# about plugin properties.
|
4741
|
+
# @return [Types::PluginProperties]
|
4742
|
+
#
|
4314
4743
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageDetails AWS API Documentation
|
4315
4744
|
#
|
4316
4745
|
class PackageDetails < Struct.new(
|
@@ -4322,7 +4751,9 @@ module Aws::OpenSearchService
|
|
4322
4751
|
:created_at,
|
4323
4752
|
:last_updated_at,
|
4324
4753
|
:available_package_version,
|
4325
|
-
:error_details
|
4754
|
+
:error_details,
|
4755
|
+
:engine_version,
|
4756
|
+
:available_plugin_properties)
|
4326
4757
|
SENSITIVE = []
|
4327
4758
|
include Aws::Structure
|
4328
4759
|
end
|
@@ -4360,12 +4791,52 @@ module Aws::OpenSearchService
|
|
4360
4791
|
# The date and time when the package was created.
|
4361
4792
|
# @return [Time]
|
4362
4793
|
#
|
4794
|
+
# @!attribute [rw] plugin_properties
|
4795
|
+
# Additional information about plugin properties if the package is a
|
4796
|
+
# `ZIP-PLUGIN` package.
|
4797
|
+
# @return [Types::PluginProperties]
|
4798
|
+
#
|
4363
4799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageVersionHistory AWS API Documentation
|
4364
4800
|
#
|
4365
4801
|
class PackageVersionHistory < Struct.new(
|
4366
4802
|
:package_version,
|
4367
4803
|
:commit_message,
|
4368
|
-
:created_at
|
4804
|
+
:created_at,
|
4805
|
+
:plugin_properties)
|
4806
|
+
SENSITIVE = []
|
4807
|
+
include Aws::Structure
|
4808
|
+
end
|
4809
|
+
|
4810
|
+
# Basic information about the plugin.
|
4811
|
+
#
|
4812
|
+
# @!attribute [rw] name
|
4813
|
+
# The name of the plugin.
|
4814
|
+
# @return [String]
|
4815
|
+
#
|
4816
|
+
# @!attribute [rw] description
|
4817
|
+
# The description of the plugin.
|
4818
|
+
# @return [String]
|
4819
|
+
#
|
4820
|
+
# @!attribute [rw] version
|
4821
|
+
# The version of the plugin.
|
4822
|
+
# @return [String]
|
4823
|
+
#
|
4824
|
+
# @!attribute [rw] class_name
|
4825
|
+
# The name of the class to load.
|
4826
|
+
# @return [String]
|
4827
|
+
#
|
4828
|
+
# @!attribute [rw] uncompressed_size_in_bytes
|
4829
|
+
# The uncompressed size of the plugin.
|
4830
|
+
# @return [Integer]
|
4831
|
+
#
|
4832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PluginProperties AWS API Documentation
|
4833
|
+
#
|
4834
|
+
class PluginProperties < Struct.new(
|
4835
|
+
:name,
|
4836
|
+
:description,
|
4837
|
+
:version,
|
4838
|
+
:class_name,
|
4839
|
+
:uncompressed_size_in_bytes)
|
4369
4840
|
SENSITIVE = []
|
4370
4841
|
include Aws::Structure
|
4371
4842
|
end
|
@@ -4655,6 +5126,20 @@ module Aws::OpenSearchService
|
|
4655
5126
|
#
|
4656
5127
|
class RevokeVpcEndpointAccessResponse < Aws::EmptyStructure; end
|
4657
5128
|
|
5129
|
+
# Information about the Amazon S3 Glue Data Catalog.
|
5130
|
+
#
|
5131
|
+
# @!attribute [rw] role_arn
|
5132
|
+
# >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
|
5133
|
+
# @return [String]
|
5134
|
+
#
|
5135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/S3GlueDataCatalog AWS API Documentation
|
5136
|
+
#
|
5137
|
+
class S3GlueDataCatalog < Struct.new(
|
5138
|
+
:role_arn)
|
5139
|
+
SENSITIVE = []
|
5140
|
+
include Aws::Structure
|
5141
|
+
end
|
5142
|
+
|
4658
5143
|
# The SAML identity povider information.
|
4659
5144
|
#
|
4660
5145
|
# @!attribute [rw] metadata_content
|
@@ -5006,6 +5491,46 @@ module Aws::OpenSearchService
|
|
5006
5491
|
include Aws::Structure
|
5007
5492
|
end
|
5008
5493
|
|
5494
|
+
# Container for the parameters to the `StartDomainMaintenance`
|
5495
|
+
# operation.
|
5496
|
+
#
|
5497
|
+
# @!attribute [rw] domain_name
|
5498
|
+
# The name of the domain.
|
5499
|
+
# @return [String]
|
5500
|
+
#
|
5501
|
+
# @!attribute [rw] action
|
5502
|
+
# The name of the action.
|
5503
|
+
# @return [String]
|
5504
|
+
#
|
5505
|
+
# @!attribute [rw] node_id
|
5506
|
+
# The ID of the data node.
|
5507
|
+
# @return [String]
|
5508
|
+
#
|
5509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceRequest AWS API Documentation
|
5510
|
+
#
|
5511
|
+
class StartDomainMaintenanceRequest < Struct.new(
|
5512
|
+
:domain_name,
|
5513
|
+
:action,
|
5514
|
+
:node_id)
|
5515
|
+
SENSITIVE = []
|
5516
|
+
include Aws::Structure
|
5517
|
+
end
|
5518
|
+
|
5519
|
+
# The result of a `StartDomainMaintenance` request that information
|
5520
|
+
# about the requested action.
|
5521
|
+
#
|
5522
|
+
# @!attribute [rw] maintenance_id
|
5523
|
+
# The request ID of requested action.
|
5524
|
+
# @return [String]
|
5525
|
+
#
|
5526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceResponse AWS API Documentation
|
5527
|
+
#
|
5528
|
+
class StartDomainMaintenanceResponse < Struct.new(
|
5529
|
+
:maintenance_id)
|
5530
|
+
SENSITIVE = []
|
5531
|
+
include Aws::Structure
|
5532
|
+
end
|
5533
|
+
|
5009
5534
|
# Container for the request parameters to the
|
5010
5535
|
# `StartServiceSoftwareUpdate` operation.
|
5011
5536
|
#
|
@@ -5154,6 +5679,49 @@ module Aws::OpenSearchService
|
|
5154
5679
|
include Aws::Structure
|
5155
5680
|
end
|
5156
5681
|
|
5682
|
+
# Container for the parameters to the `UpdateDataSource` operation.
|
5683
|
+
#
|
5684
|
+
# @!attribute [rw] domain_name
|
5685
|
+
# The name of the domain.
|
5686
|
+
# @return [String]
|
5687
|
+
#
|
5688
|
+
# @!attribute [rw] name
|
5689
|
+
# The name of the data source to modify.
|
5690
|
+
# @return [String]
|
5691
|
+
#
|
5692
|
+
# @!attribute [rw] data_source_type
|
5693
|
+
# The type of data source.
|
5694
|
+
# @return [Types::DataSourceType]
|
5695
|
+
#
|
5696
|
+
# @!attribute [rw] description
|
5697
|
+
# A new description of the data source.
|
5698
|
+
# @return [String]
|
5699
|
+
#
|
5700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceRequest AWS API Documentation
|
5701
|
+
#
|
5702
|
+
class UpdateDataSourceRequest < Struct.new(
|
5703
|
+
:domain_name,
|
5704
|
+
:name,
|
5705
|
+
:data_source_type,
|
5706
|
+
:description)
|
5707
|
+
SENSITIVE = []
|
5708
|
+
include Aws::Structure
|
5709
|
+
end
|
5710
|
+
|
5711
|
+
# The result of an `UpdateDataSource` operation.
|
5712
|
+
#
|
5713
|
+
# @!attribute [rw] message
|
5714
|
+
# A message associated with the updated data source.
|
5715
|
+
# @return [String]
|
5716
|
+
#
|
5717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceResponse AWS API Documentation
|
5718
|
+
#
|
5719
|
+
class UpdateDataSourceResponse < Struct.new(
|
5720
|
+
:message)
|
5721
|
+
SENSITIVE = []
|
5722
|
+
include Aws::Structure
|
5723
|
+
end
|
5724
|
+
|
5157
5725
|
# Container for the request parameters to the `UpdateDomain` operation.
|
5158
5726
|
#
|
5159
5727
|
# @!attribute [rw] domain_name
|
@@ -5223,6 +5791,13 @@ module Aws::OpenSearchService
|
|
5223
5791
|
# JSON-formatted string.
|
5224
5792
|
# @return [String]
|
5225
5793
|
#
|
5794
|
+
# @!attribute [rw] ip_address_type
|
5795
|
+
# Specify either dual stack or IPv4 as your IP address type. Dual
|
5796
|
+
# stack allows you to share domain resources across IPv4 and IPv6
|
5797
|
+
# address types, and is the recommended option. If your IP address
|
5798
|
+
# type is currently set to dual stack, you can't change it.
|
5799
|
+
# @return [String]
|
5800
|
+
#
|
5226
5801
|
# @!attribute [rw] log_publishing_options
|
5227
5802
|
# Options to publish OpenSearch logs to Amazon CloudWatch Logs.
|
5228
5803
|
# @return [Hash<String,Types::LogPublishingOption>]
|
@@ -5288,6 +5863,7 @@ module Aws::OpenSearchService
|
|
5288
5863
|
:cognito_options,
|
5289
5864
|
:advanced_options,
|
5290
5865
|
:access_policies,
|
5866
|
+
:ip_address_type,
|
5291
5867
|
:log_publishing_options,
|
5292
5868
|
:encryption_at_rest_options,
|
5293
5869
|
:domain_endpoint_options,
|