aws-sdk-opensearchservice 1.26.0 → 1.42.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 +80 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +663 -93
- data/lib/aws-sdk-opensearchservice/client_api.rb +338 -0
- data/lib/aws-sdk-opensearchservice/endpoint_provider.rb +10 -1
- data/lib/aws-sdk-opensearchservice/endpoints.rb +126 -0
- data/lib/aws-sdk-opensearchservice/plugins/endpoints.rb +22 -2
- data/lib/aws-sdk-opensearchservice/types.rb +806 -39
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +1120 -0
- data/sig/errors.rbs +44 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +1674 -0
- data/sig/waiters.rbs +13 -0
- metadata +14 -9
@@ -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
|
#
|
@@ -719,6 +762,49 @@ module Aws::OpenSearchService
|
|
719
762
|
include Aws::Structure
|
720
763
|
end
|
721
764
|
|
765
|
+
# @!attribute [rw] domain_name
|
766
|
+
# The name of an OpenSearch Service domain. Domain names are unique
|
767
|
+
# across the domains owned by an account within an Amazon Web Services
|
768
|
+
# Region.
|
769
|
+
# @return [String]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] dry_run
|
772
|
+
# When set to `True`, returns the list of change IDs and properties
|
773
|
+
# that will be cancelled without actually cancelling the change.
|
774
|
+
# @return [Boolean]
|
775
|
+
#
|
776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChangeRequest AWS API Documentation
|
777
|
+
#
|
778
|
+
class CancelDomainConfigChangeRequest < Struct.new(
|
779
|
+
:domain_name,
|
780
|
+
:dry_run)
|
781
|
+
SENSITIVE = []
|
782
|
+
include Aws::Structure
|
783
|
+
end
|
784
|
+
|
785
|
+
# @!attribute [rw] cancelled_change_ids
|
786
|
+
# The unique identifiers of the changes that were cancelled.
|
787
|
+
# @return [Array<String>]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] cancelled_change_properties
|
790
|
+
# The domain change properties that were cancelled.
|
791
|
+
# @return [Array<Types::CancelledChangeProperty>]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] dry_run
|
794
|
+
# Whether or not the request was a dry run. If `True`, the changes
|
795
|
+
# were not actually cancelled.
|
796
|
+
# @return [Boolean]
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChangeResponse AWS API Documentation
|
799
|
+
#
|
800
|
+
class CancelDomainConfigChangeResponse < Struct.new(
|
801
|
+
:cancelled_change_ids,
|
802
|
+
:cancelled_change_properties,
|
803
|
+
:dry_run)
|
804
|
+
SENSITIVE = []
|
805
|
+
include Aws::Structure
|
806
|
+
end
|
807
|
+
|
722
808
|
# Container for the request parameters to cancel a service software
|
723
809
|
# update.
|
724
810
|
#
|
@@ -751,6 +837,33 @@ module Aws::OpenSearchService
|
|
751
837
|
include Aws::Structure
|
752
838
|
end
|
753
839
|
|
840
|
+
# A property change that was cancelled for an Amazon OpenSearch Service
|
841
|
+
# domain.
|
842
|
+
#
|
843
|
+
# @!attribute [rw] property_name
|
844
|
+
# The name of the property whose change was cancelled.
|
845
|
+
# @return [String]
|
846
|
+
#
|
847
|
+
# @!attribute [rw] cancelled_value
|
848
|
+
# The pending value of the property that was cancelled. This would
|
849
|
+
# have been the eventual value of the property if the chance had not
|
850
|
+
# been cancelled.
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] active_value
|
854
|
+
# The current value of the property, after the change was cancelled.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelledChangeProperty AWS API Documentation
|
858
|
+
#
|
859
|
+
class CancelledChangeProperty < Struct.new(
|
860
|
+
:property_name,
|
861
|
+
:cancelled_value,
|
862
|
+
:active_value)
|
863
|
+
SENSITIVE = []
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
754
867
|
# Container for information about a configuration change happening on a
|
755
868
|
# domain.
|
756
869
|
#
|
@@ -762,11 +875,32 @@ module Aws::OpenSearchService
|
|
762
875
|
# A message corresponding to the status of the configuration change.
|
763
876
|
# @return [String]
|
764
877
|
#
|
878
|
+
# @!attribute [rw] config_change_status
|
879
|
+
# The current status of the configuration change.
|
880
|
+
# @return [String]
|
881
|
+
#
|
882
|
+
# @!attribute [rw] initiated_by
|
883
|
+
# The IAM principal who initiated the configuration change.
|
884
|
+
# @return [String]
|
885
|
+
#
|
886
|
+
# @!attribute [rw] start_time
|
887
|
+
# The time that the configuration change was initiated, in Universal
|
888
|
+
# Coordinated Time (UTC).
|
889
|
+
# @return [Time]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] last_updated_time
|
892
|
+
# The last time that the configuration change was updated.
|
893
|
+
# @return [Time]
|
894
|
+
#
|
765
895
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ChangeProgressDetails AWS API Documentation
|
766
896
|
#
|
767
897
|
class ChangeProgressDetails < Struct.new(
|
768
898
|
:change_id,
|
769
|
-
:message
|
899
|
+
:message,
|
900
|
+
:config_change_status,
|
901
|
+
:initiated_by,
|
902
|
+
:start_time,
|
903
|
+
:last_updated_time)
|
770
904
|
SENSITIVE = []
|
771
905
|
include Aws::Structure
|
772
906
|
end
|
@@ -834,6 +968,19 @@ module Aws::OpenSearchService
|
|
834
968
|
# configuration change.
|
835
969
|
# @return [Array<Types::ChangeProgressStage>]
|
836
970
|
#
|
971
|
+
# @!attribute [rw] last_updated_time
|
972
|
+
# The last time that the status of the configuration change was
|
973
|
+
# updated.
|
974
|
+
# @return [Time]
|
975
|
+
#
|
976
|
+
# @!attribute [rw] config_change_status
|
977
|
+
# The current status of the configuration change.
|
978
|
+
# @return [String]
|
979
|
+
#
|
980
|
+
# @!attribute [rw] initiated_by
|
981
|
+
# The IAM principal who initiated the configuration change.
|
982
|
+
# @return [String]
|
983
|
+
#
|
837
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ChangeProgressStatusDetails AWS API Documentation
|
838
985
|
#
|
839
986
|
class ChangeProgressStatusDetails < Struct.new(
|
@@ -843,7 +990,10 @@ module Aws::OpenSearchService
|
|
843
990
|
:pending_properties,
|
844
991
|
:completed_properties,
|
845
992
|
:total_number_of_stages,
|
846
|
-
:change_progress_stages
|
993
|
+
:change_progress_stages,
|
994
|
+
:last_updated_time,
|
995
|
+
:config_change_status,
|
996
|
+
:initiated_by)
|
847
997
|
SENSITIVE = []
|
848
998
|
include Aws::Structure
|
849
999
|
end
|
@@ -861,8 +1011,8 @@ module Aws::OpenSearchService
|
|
861
1011
|
# @return [String]
|
862
1012
|
#
|
863
1013
|
# @!attribute [rw] instance_count
|
864
|
-
# Number of
|
865
|
-
#
|
1014
|
+
# Number of data nodes in the cluster. This number must be greater
|
1015
|
+
# than 1, otherwise you receive a validation exception.
|
866
1016
|
# @return [Integer]
|
867
1017
|
#
|
868
1018
|
# @!attribute [rw] dedicated_master_enabled
|
@@ -1030,7 +1180,8 @@ module Aws::OpenSearchService
|
|
1030
1180
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html
|
1031
1181
|
#
|
1032
1182
|
# @!attribute [rw] enabled
|
1033
|
-
# Whether to enable or disable cold storage on the domain.
|
1183
|
+
# Whether to enable or disable cold storage on the domain. You must
|
1184
|
+
# enable UltraWarm storage to enable cold storage.
|
1034
1185
|
# @return [Boolean]
|
1035
1186
|
#
|
1036
1187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ColdStorageOptions AWS API Documentation
|
@@ -1121,6 +1272,14 @@ module Aws::OpenSearchService
|
|
1121
1272
|
# access policies for the new domain.
|
1122
1273
|
# @return [String]
|
1123
1274
|
#
|
1275
|
+
# @!attribute [rw] ip_address_type
|
1276
|
+
# Specify either dual stack or IPv4 as your IP address type. Dual
|
1277
|
+
# stack allows you to share domain resources across IPv4 and IPv6
|
1278
|
+
# address types, and is the recommended option. If you set your IP
|
1279
|
+
# address type to dual stack, you can't change your address type
|
1280
|
+
# later.
|
1281
|
+
# @return [String]
|
1282
|
+
#
|
1124
1283
|
# @!attribute [rw] snapshot_options
|
1125
1284
|
# DEPRECATED. Container for the parameters required to configure
|
1126
1285
|
# automated snapshots of domain indexes.
|
@@ -1231,6 +1390,7 @@ module Aws::OpenSearchService
|
|
1231
1390
|
:cluster_config,
|
1232
1391
|
:ebs_options,
|
1233
1392
|
:access_policies,
|
1393
|
+
:ip_address_type,
|
1234
1394
|
:snapshot_options,
|
1235
1395
|
:vpc_options,
|
1236
1396
|
:cognito_options,
|
@@ -1423,10 +1583,13 @@ module Aws::OpenSearchService
|
|
1423
1583
|
include Aws::Structure
|
1424
1584
|
end
|
1425
1585
|
|
1426
|
-
# Cross
|
1586
|
+
# Cross-cluster search specific connection properties.
|
1427
1587
|
#
|
1428
1588
|
# @!attribute [rw] skip_unavailable
|
1429
|
-
#
|
1589
|
+
# The status of the `SkipUnavailable` setting for the outbound
|
1590
|
+
# connection. This feature allows you to specify some clusters as
|
1591
|
+
# optional and ensure that your cross-cluster queries return partial
|
1592
|
+
# results despite failures on one or more remote clusters.
|
1430
1593
|
# @return [String]
|
1431
1594
|
#
|
1432
1595
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CrossClusterSearchConnectionProperties AWS API Documentation
|
@@ -1437,6 +1600,91 @@ module Aws::OpenSearchService
|
|
1437
1600
|
include Aws::Structure
|
1438
1601
|
end
|
1439
1602
|
|
1603
|
+
# Details about a direct-query data source.
|
1604
|
+
#
|
1605
|
+
# @!attribute [rw] data_source_type
|
1606
|
+
# The type of data source.
|
1607
|
+
# @return [Types::DataSourceType]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] name
|
1610
|
+
# The name of the data source.
|
1611
|
+
# @return [String]
|
1612
|
+
#
|
1613
|
+
# @!attribute [rw] description
|
1614
|
+
# A description of the data source.
|
1615
|
+
# @return [String]
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] status
|
1618
|
+
# The status of the data source.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceDetails AWS API Documentation
|
1622
|
+
#
|
1623
|
+
class DataSourceDetails < Struct.new(
|
1624
|
+
:data_source_type,
|
1625
|
+
:name,
|
1626
|
+
:description,
|
1627
|
+
:status)
|
1628
|
+
SENSITIVE = []
|
1629
|
+
include Aws::Structure
|
1630
|
+
end
|
1631
|
+
|
1632
|
+
# The type of data source.
|
1633
|
+
#
|
1634
|
+
# @note DataSourceType is a union - when making an API calls you must set exactly one of the members.
|
1635
|
+
#
|
1636
|
+
# @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.
|
1637
|
+
#
|
1638
|
+
# @!attribute [rw] s3_glue_data_catalog
|
1639
|
+
# An Amazon S3 data source.
|
1640
|
+
# @return [Types::S3GlueDataCatalog]
|
1641
|
+
#
|
1642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceType AWS API Documentation
|
1643
|
+
#
|
1644
|
+
class DataSourceType < Struct.new(
|
1645
|
+
:s3_glue_data_catalog,
|
1646
|
+
:unknown)
|
1647
|
+
SENSITIVE = []
|
1648
|
+
include Aws::Structure
|
1649
|
+
include Aws::Structure::Union
|
1650
|
+
|
1651
|
+
class S3GlueDataCatalog < DataSourceType; end
|
1652
|
+
class Unknown < DataSourceType; end
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
# Container for the parameters to the `DeleteDataSource` operation.
|
1656
|
+
#
|
1657
|
+
# @!attribute [rw] domain_name
|
1658
|
+
# The name of the domain.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] name
|
1662
|
+
# The name of the data source to delete.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceRequest AWS API Documentation
|
1666
|
+
#
|
1667
|
+
class DeleteDataSourceRequest < Struct.new(
|
1668
|
+
:domain_name,
|
1669
|
+
:name)
|
1670
|
+
SENSITIVE = []
|
1671
|
+
include Aws::Structure
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# The result of a `GetDataSource` operation.
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] message
|
1677
|
+
# A message associated with deletion of the data source.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceResponse AWS API Documentation
|
1681
|
+
#
|
1682
|
+
class DeleteDataSourceResponse < Struct.new(
|
1683
|
+
:message)
|
1684
|
+
SENSITIVE = []
|
1685
|
+
include Aws::Structure
|
1686
|
+
end
|
1687
|
+
|
1440
1688
|
# Container for the parameters to the `DeleteDomain` operation.
|
1441
1689
|
#
|
1442
1690
|
# @!attribute [rw] domain_name
|
@@ -1628,7 +1876,7 @@ module Aws::OpenSearchService
|
|
1628
1876
|
# @!attribute [rw] next_token
|
1629
1877
|
# When `nextToken` is returned, there are more results available. The
|
1630
1878
|
# value of `nextToken` is a unique pagination token for each page.
|
1631
|
-
#
|
1879
|
+
# Send the request again using the returned token to retrieve the next
|
1632
1880
|
# page.
|
1633
1881
|
# @return [String]
|
1634
1882
|
#
|
@@ -1892,8 +2140,7 @@ module Aws::OpenSearchService
|
|
1892
2140
|
#
|
1893
2141
|
# @!attribute [rw] domain_names
|
1894
2142
|
# Array of OpenSearch Service domain names that you want information
|
1895
|
-
# about.
|
1896
|
-
# information about all domains owned by the account.
|
2143
|
+
# about. You must specify at least one domain name.
|
1897
2144
|
# @return [Array<String>]
|
1898
2145
|
#
|
1899
2146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainsRequest AWS API Documentation
|
@@ -2004,7 +2251,7 @@ module Aws::OpenSearchService
|
|
2004
2251
|
# @!attribute [rw] next_token
|
2005
2252
|
# When `nextToken` is returned, there are more results available. The
|
2006
2253
|
# value of `nextToken` is a unique pagination token for each page.
|
2007
|
-
#
|
2254
|
+
# Send the request again using the returned token to retrieve the next
|
2008
2255
|
# page.
|
2009
2256
|
# @return [String]
|
2010
2257
|
#
|
@@ -2100,7 +2347,7 @@ module Aws::OpenSearchService
|
|
2100
2347
|
# @!attribute [rw] next_token
|
2101
2348
|
# When `nextToken` is returned, there are more results available. The
|
2102
2349
|
# value of `nextToken` is a unique pagination token for each page.
|
2103
|
-
#
|
2350
|
+
# Send the request again using the returned token to retrieve the next
|
2104
2351
|
# page.
|
2105
2352
|
# @return [String]
|
2106
2353
|
#
|
@@ -2172,7 +2419,7 @@ module Aws::OpenSearchService
|
|
2172
2419
|
# @!attribute [rw] next_token
|
2173
2420
|
# When `nextToken` is returned, there are more results available. The
|
2174
2421
|
# value of `nextToken` is a unique pagination token for each page.
|
2175
|
-
#
|
2422
|
+
# Send the request again using the returned token to retrieve the next
|
2176
2423
|
# page.
|
2177
2424
|
# @return [String]
|
2178
2425
|
#
|
@@ -2222,7 +2469,7 @@ module Aws::OpenSearchService
|
|
2222
2469
|
# @!attribute [rw] next_token
|
2223
2470
|
# When `nextToken` is returned, there are more results available. The
|
2224
2471
|
# value of `nextToken` is a unique pagination token for each page.
|
2225
|
-
#
|
2472
|
+
# Send the request again using the returned token to retrieve the next
|
2226
2473
|
# page.
|
2227
2474
|
# @return [String]
|
2228
2475
|
#
|
@@ -2275,7 +2522,7 @@ module Aws::OpenSearchService
|
|
2275
2522
|
# @!attribute [rw] next_token
|
2276
2523
|
# When `nextToken` is returned, there are more results available. The
|
2277
2524
|
# value of `nextToken` is a unique pagination token for each page.
|
2278
|
-
#
|
2525
|
+
# Send the request again using the returned token to retrieve the next
|
2279
2526
|
# page.
|
2280
2527
|
# @return [String]
|
2281
2528
|
#
|
@@ -2383,6 +2630,13 @@ module Aws::OpenSearchService
|
|
2383
2630
|
# Specifies the access policies for the domain.
|
2384
2631
|
# @return [Types::AccessPoliciesStatus]
|
2385
2632
|
#
|
2633
|
+
# @!attribute [rw] ip_address_type
|
2634
|
+
# Choose either dual stack or IPv4 as your IP address type. Dual stack
|
2635
|
+
# allows you to share domain resources across IPv4 and IPv6 address
|
2636
|
+
# types, and is the recommended option. If you set your IP address
|
2637
|
+
# type to dual stack, you can't change your address type later.
|
2638
|
+
# @return [Types::IPAddressTypeStatus]
|
2639
|
+
#
|
2386
2640
|
# @!attribute [rw] snapshot_options
|
2387
2641
|
# DEPRECATED. Container for parameters required to configure automated
|
2388
2642
|
# snapshots of domain indexes.
|
@@ -2444,6 +2698,11 @@ module Aws::OpenSearchService
|
|
2444
2698
|
# Software update options for the domain.
|
2445
2699
|
# @return [Types::SoftwareUpdateOptionsStatus]
|
2446
2700
|
#
|
2701
|
+
# @!attribute [rw] modifying_properties
|
2702
|
+
# Information about the domain properties that are currently being
|
2703
|
+
# modified.
|
2704
|
+
# @return [Array<Types::ModifyingProperties>]
|
2705
|
+
#
|
2447
2706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainConfig AWS API Documentation
|
2448
2707
|
#
|
2449
2708
|
class DomainConfig < Struct.new(
|
@@ -2451,6 +2710,7 @@ module Aws::OpenSearchService
|
|
2451
2710
|
:cluster_config,
|
2452
2711
|
:ebs_options,
|
2453
2712
|
:access_policies,
|
2713
|
+
:ip_address_type,
|
2454
2714
|
:snapshot_options,
|
2455
2715
|
:vpc_options,
|
2456
2716
|
:cognito_options,
|
@@ -2463,7 +2723,8 @@ module Aws::OpenSearchService
|
|
2463
2723
|
:auto_tune_options,
|
2464
2724
|
:change_progress_details,
|
2465
2725
|
:off_peak_window_options,
|
2466
|
-
:software_update_options
|
2726
|
+
:software_update_options,
|
2727
|
+
:modifying_properties)
|
2467
2728
|
SENSITIVE = []
|
2468
2729
|
include Aws::Structure
|
2469
2730
|
end
|
@@ -2477,15 +2738,17 @@ module Aws::OpenSearchService
|
|
2477
2738
|
#
|
2478
2739
|
# @!attribute [rw] tls_security_policy
|
2479
2740
|
# Specify the TLS security policy to apply to the HTTPS endpoint of
|
2480
|
-
# the domain.
|
2481
|
-
#
|
2482
|
-
# Can be one of the following values:
|
2741
|
+
# the domain. The policy can be one of the following values:
|
2483
2742
|
#
|
2484
|
-
# * **Policy-Min-TLS-1-0-2019-07:** TLS security policy
|
2485
|
-
# TLS version 1.0
|
2743
|
+
# * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports
|
2744
|
+
# TLS version 1.0 to TLS version 1.2
|
2486
2745
|
#
|
2487
|
-
# * **Policy-Min-TLS-1-2-2019-07:** TLS security policy
|
2746
|
+
# * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports
|
2488
2747
|
# only TLS version 1.2
|
2748
|
+
#
|
2749
|
+
# * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that
|
2750
|
+
# supports TLS version 1.2 to TLS version 1.3 with perfect forward
|
2751
|
+
# secrecy cipher suites
|
2489
2752
|
# @return [String]
|
2490
2753
|
#
|
2491
2754
|
# @!attribute [rw] custom_endpoint_enabled
|
@@ -2567,6 +2830,55 @@ module Aws::OpenSearchService
|
|
2567
2830
|
include Aws::Structure
|
2568
2831
|
end
|
2569
2832
|
|
2833
|
+
# Container for the domain maintenance details.
|
2834
|
+
#
|
2835
|
+
# @!attribute [rw] maintenance_id
|
2836
|
+
# The ID of the requested action.
|
2837
|
+
# @return [String]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] domain_name
|
2840
|
+
# The name of the domain.
|
2841
|
+
# @return [String]
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] action
|
2844
|
+
# The name of the action.
|
2845
|
+
# @return [String]
|
2846
|
+
#
|
2847
|
+
# @!attribute [rw] node_id
|
2848
|
+
# The ID of the data node.
|
2849
|
+
# @return [String]
|
2850
|
+
#
|
2851
|
+
# @!attribute [rw] status
|
2852
|
+
# The status of the action.
|
2853
|
+
# @return [String]
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] status_message
|
2856
|
+
# The status message for the action.
|
2857
|
+
# @return [String]
|
2858
|
+
#
|
2859
|
+
# @!attribute [rw] created_at
|
2860
|
+
# The time at which the action was created.
|
2861
|
+
# @return [Time]
|
2862
|
+
#
|
2863
|
+
# @!attribute [rw] updated_at
|
2864
|
+
# The time at which the action was updated.
|
2865
|
+
# @return [Time]
|
2866
|
+
#
|
2867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainMaintenanceDetails AWS API Documentation
|
2868
|
+
#
|
2869
|
+
class DomainMaintenanceDetails < Struct.new(
|
2870
|
+
:maintenance_id,
|
2871
|
+
:domain_name,
|
2872
|
+
:action,
|
2873
|
+
:node_id,
|
2874
|
+
:status,
|
2875
|
+
:status_message,
|
2876
|
+
:created_at,
|
2877
|
+
:updated_at)
|
2878
|
+
SENSITIVE = []
|
2879
|
+
include Aws::Structure
|
2880
|
+
end
|
2881
|
+
|
2570
2882
|
# Container for information about nodes on the domain.
|
2571
2883
|
#
|
2572
2884
|
# @!attribute [rw] node_id
|
@@ -2717,12 +3029,28 @@ module Aws::OpenSearchService
|
|
2717
3029
|
# upload requests to the domain.
|
2718
3030
|
# @return [String]
|
2719
3031
|
#
|
3032
|
+
# @!attribute [rw] endpoint_v2
|
3033
|
+
# If `IPAddressType` to set to `dualstack`, a version 2 domain
|
3034
|
+
# endpoint is provisioned. This endpoint functions like a normal
|
3035
|
+
# endpoint, except that it works with both IPv4 and IPv6 IP addresses.
|
3036
|
+
# Normal endpoints work only with IPv4 IP addresses.
|
3037
|
+
# @return [String]
|
3038
|
+
#
|
2720
3039
|
# @!attribute [rw] endpoints
|
2721
3040
|
# The key-value pair that exists if the OpenSearch Service domain uses
|
2722
|
-
# VPC endpoints
|
2723
|
-
#
|
3041
|
+
# VPC endpoints. For example:
|
3042
|
+
#
|
3043
|
+
# * **IPv4 IP addresses** -
|
3044
|
+
# `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`
|
3045
|
+
#
|
3046
|
+
# * **Dual stack IP addresses** -
|
3047
|
+
# `'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'`
|
2724
3048
|
# @return [Hash<String,String>]
|
2725
3049
|
#
|
3050
|
+
# @!attribute [rw] domain_endpoint_v2_hosted_zone_id
|
3051
|
+
# The dual stack hosted zone ID for the domain.
|
3052
|
+
# @return [String]
|
3053
|
+
#
|
2726
3054
|
# @!attribute [rw] processing
|
2727
3055
|
# The status of the domain configuration. True if OpenSearch Service
|
2728
3056
|
# is processing configuration changes. False if the configuration is
|
@@ -2753,6 +3081,10 @@ module Aws::OpenSearchService
|
|
2753
3081
|
# access policies for the domain.
|
2754
3082
|
# @return [String]
|
2755
3083
|
#
|
3084
|
+
# @!attribute [rw] ip_address_type
|
3085
|
+
# The type of IP addresses supported by the endpoint for the domain.
|
3086
|
+
# @return [String]
|
3087
|
+
#
|
2756
3088
|
# @!attribute [rw] snapshot_options
|
2757
3089
|
# DEPRECATED. Container for parameters required to configure automated
|
2758
3090
|
# snapshots of domain indexes.
|
@@ -2813,6 +3145,16 @@ module Aws::OpenSearchService
|
|
2813
3145
|
# Service software update options for the domain.
|
2814
3146
|
# @return [Types::SoftwareUpdateOptions]
|
2815
3147
|
#
|
3148
|
+
# @!attribute [rw] domain_processing_status
|
3149
|
+
# The status of any changes that are currently in progress for the
|
3150
|
+
# domain.
|
3151
|
+
# @return [String]
|
3152
|
+
#
|
3153
|
+
# @!attribute [rw] modifying_properties
|
3154
|
+
# Information about the domain properties that are currently being
|
3155
|
+
# modified.
|
3156
|
+
# @return [Array<Types::ModifyingProperties>]
|
3157
|
+
#
|
2816
3158
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainStatus AWS API Documentation
|
2817
3159
|
#
|
2818
3160
|
class DomainStatus < Struct.new(
|
@@ -2822,13 +3164,16 @@ module Aws::OpenSearchService
|
|
2822
3164
|
:created,
|
2823
3165
|
:deleted,
|
2824
3166
|
:endpoint,
|
3167
|
+
:endpoint_v2,
|
2825
3168
|
:endpoints,
|
3169
|
+
:domain_endpoint_v2_hosted_zone_id,
|
2826
3170
|
:processing,
|
2827
3171
|
:upgrade_processing,
|
2828
3172
|
:engine_version,
|
2829
3173
|
:cluster_config,
|
2830
3174
|
:ebs_options,
|
2831
3175
|
:access_policies,
|
3176
|
+
:ip_address_type,
|
2832
3177
|
:snapshot_options,
|
2833
3178
|
:vpc_options,
|
2834
3179
|
:cognito_options,
|
@@ -2842,7 +3187,9 @@ module Aws::OpenSearchService
|
|
2842
3187
|
:auto_tune_options,
|
2843
3188
|
:change_progress_details,
|
2844
3189
|
:off_peak_window_options,
|
2845
|
-
:software_update_options
|
3190
|
+
:software_update_options,
|
3191
|
+
:domain_processing_status,
|
3192
|
+
:modifying_properties)
|
2846
3193
|
SENSITIVE = []
|
2847
3194
|
include Aws::Structure
|
2848
3195
|
end
|
@@ -2995,8 +3342,10 @@ module Aws::OpenSearchService
|
|
2995
3342
|
end
|
2996
3343
|
|
2997
3344
|
# Specifies whether the domain should encrypt data at rest, and if so,
|
2998
|
-
# the Key Management Service (KMS) key to use. Can be used
|
2999
|
-
#
|
3345
|
+
# the Key Management Service (KMS) key to use. Can only be used when
|
3346
|
+
# creating a new domain or enabling encryption at rest for the first
|
3347
|
+
# time on an existing domain. You can't modify this parameter after
|
3348
|
+
# it's already been specified.
|
3000
3349
|
#
|
3001
3350
|
# @!attribute [rw] enabled
|
3002
3351
|
# True to enable encryption at rest.
|
@@ -3125,6 +3474,114 @@ module Aws::OpenSearchService
|
|
3125
3474
|
include Aws::Structure
|
3126
3475
|
end
|
3127
3476
|
|
3477
|
+
# Container for the parameters to the `GetDataSource` operation.
|
3478
|
+
#
|
3479
|
+
# @!attribute [rw] domain_name
|
3480
|
+
# The name of the domain.
|
3481
|
+
# @return [String]
|
3482
|
+
#
|
3483
|
+
# @!attribute [rw] name
|
3484
|
+
# The name of the data source to get information about.
|
3485
|
+
# @return [String]
|
3486
|
+
#
|
3487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceRequest AWS API Documentation
|
3488
|
+
#
|
3489
|
+
class GetDataSourceRequest < Struct.new(
|
3490
|
+
:domain_name,
|
3491
|
+
:name)
|
3492
|
+
SENSITIVE = []
|
3493
|
+
include Aws::Structure
|
3494
|
+
end
|
3495
|
+
|
3496
|
+
# The result of a `GetDataSource` operation.
|
3497
|
+
#
|
3498
|
+
# @!attribute [rw] data_source_type
|
3499
|
+
# The type of data source.
|
3500
|
+
# @return [Types::DataSourceType]
|
3501
|
+
#
|
3502
|
+
# @!attribute [rw] name
|
3503
|
+
# The name of the data source.
|
3504
|
+
# @return [String]
|
3505
|
+
#
|
3506
|
+
# @!attribute [rw] description
|
3507
|
+
# A description of the data source.
|
3508
|
+
# @return [String]
|
3509
|
+
#
|
3510
|
+
# @!attribute [rw] status
|
3511
|
+
# The status of the data source response.
|
3512
|
+
# @return [String]
|
3513
|
+
#
|
3514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceResponse AWS API Documentation
|
3515
|
+
#
|
3516
|
+
class GetDataSourceResponse < Struct.new(
|
3517
|
+
:data_source_type,
|
3518
|
+
:name,
|
3519
|
+
:description,
|
3520
|
+
:status)
|
3521
|
+
SENSITIVE = []
|
3522
|
+
include Aws::Structure
|
3523
|
+
end
|
3524
|
+
|
3525
|
+
# Container for the parameters to the `GetDomainMaintenanceStatus`
|
3526
|
+
# operation.
|
3527
|
+
#
|
3528
|
+
# @!attribute [rw] domain_name
|
3529
|
+
# The name of the domain.
|
3530
|
+
# @return [String]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] maintenance_id
|
3533
|
+
# The request ID of the maintenance action.
|
3534
|
+
# @return [String]
|
3535
|
+
#
|
3536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusRequest AWS API Documentation
|
3537
|
+
#
|
3538
|
+
class GetDomainMaintenanceStatusRequest < Struct.new(
|
3539
|
+
:domain_name,
|
3540
|
+
:maintenance_id)
|
3541
|
+
SENSITIVE = []
|
3542
|
+
include Aws::Structure
|
3543
|
+
end
|
3544
|
+
|
3545
|
+
# The result of a `GetDomainMaintenanceStatus` request that information
|
3546
|
+
# about the requested action.
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] status
|
3549
|
+
# The status of the maintenance action.
|
3550
|
+
# @return [String]
|
3551
|
+
#
|
3552
|
+
# @!attribute [rw] status_message
|
3553
|
+
# The status message of the maintenance action.
|
3554
|
+
# @return [String]
|
3555
|
+
#
|
3556
|
+
# @!attribute [rw] node_id
|
3557
|
+
# The node ID of the maintenance action.
|
3558
|
+
# @return [String]
|
3559
|
+
#
|
3560
|
+
# @!attribute [rw] action
|
3561
|
+
# The action name.
|
3562
|
+
# @return [String]
|
3563
|
+
#
|
3564
|
+
# @!attribute [rw] created_at
|
3565
|
+
# The time at which the action was created.
|
3566
|
+
# @return [Time]
|
3567
|
+
#
|
3568
|
+
# @!attribute [rw] updated_at
|
3569
|
+
# The time at which the action was updated.
|
3570
|
+
# @return [Time]
|
3571
|
+
#
|
3572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusResponse AWS API Documentation
|
3573
|
+
#
|
3574
|
+
class GetDomainMaintenanceStatusResponse < Struct.new(
|
3575
|
+
:status,
|
3576
|
+
:status_message,
|
3577
|
+
:node_id,
|
3578
|
+
:action,
|
3579
|
+
:created_at,
|
3580
|
+
:updated_at)
|
3581
|
+
SENSITIVE = []
|
3582
|
+
include Aws::Structure
|
3583
|
+
end
|
3584
|
+
|
3128
3585
|
# Container for the request parameters to the `GetPackageVersionHistory`
|
3129
3586
|
# operation.
|
3130
3587
|
#
|
@@ -3169,7 +3626,7 @@ module Aws::OpenSearchService
|
|
3169
3626
|
# @!attribute [rw] next_token
|
3170
3627
|
# When `nextToken` is returned, there are more results available. The
|
3171
3628
|
# value of `nextToken` is a unique pagination token for each page.
|
3172
|
-
#
|
3629
|
+
# Send the request again using the returned token to retrieve the next
|
3173
3630
|
# page.
|
3174
3631
|
# @return [String]
|
3175
3632
|
#
|
@@ -3223,7 +3680,7 @@ module Aws::OpenSearchService
|
|
3223
3680
|
# @!attribute [rw] next_token
|
3224
3681
|
# When `nextToken` is returned, there are more results available. The
|
3225
3682
|
# value of `nextToken` is a unique pagination token for each page.
|
3226
|
-
#
|
3683
|
+
# Send the request again using the returned token to retrieve the next
|
3227
3684
|
# page.
|
3228
3685
|
# @return [String]
|
3229
3686
|
#
|
@@ -3277,6 +3734,25 @@ module Aws::OpenSearchService
|
|
3277
3734
|
include Aws::Structure
|
3278
3735
|
end
|
3279
3736
|
|
3737
|
+
# The IP address type status for the domain.
|
3738
|
+
#
|
3739
|
+
# @!attribute [rw] options
|
3740
|
+
# The IP address options for the domain.
|
3741
|
+
# @return [String]
|
3742
|
+
#
|
3743
|
+
# @!attribute [rw] status
|
3744
|
+
# Provides the current status of an entity.
|
3745
|
+
# @return [Types::OptionStatus]
|
3746
|
+
#
|
3747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IPAddressTypeStatus AWS API Documentation
|
3748
|
+
#
|
3749
|
+
class IPAddressTypeStatus < Struct.new(
|
3750
|
+
:options,
|
3751
|
+
:status)
|
3752
|
+
SENSITIVE = []
|
3753
|
+
include Aws::Structure
|
3754
|
+
end
|
3755
|
+
|
3280
3756
|
# Describes an inbound cross-cluster connection for Amazon OpenSearch
|
3281
3757
|
# Service. For more information, see [Cross-cluster search for Amazon
|
3282
3758
|
# OpenSearch Service][1].
|
@@ -3499,6 +3975,96 @@ module Aws::OpenSearchService
|
|
3499
3975
|
include Aws::Structure
|
3500
3976
|
end
|
3501
3977
|
|
3978
|
+
# Container for the parameters to the `ListDataSources` operation.
|
3979
|
+
#
|
3980
|
+
# @!attribute [rw] domain_name
|
3981
|
+
# The name of the domain.
|
3982
|
+
# @return [String]
|
3983
|
+
#
|
3984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesRequest AWS API Documentation
|
3985
|
+
#
|
3986
|
+
class ListDataSourcesRequest < Struct.new(
|
3987
|
+
:domain_name)
|
3988
|
+
SENSITIVE = []
|
3989
|
+
include Aws::Structure
|
3990
|
+
end
|
3991
|
+
|
3992
|
+
# The result of a `ListDataSources` operation.
|
3993
|
+
#
|
3994
|
+
# @!attribute [rw] data_sources
|
3995
|
+
# A list of data sources associated with specified domain.
|
3996
|
+
# @return [Array<Types::DataSourceDetails>]
|
3997
|
+
#
|
3998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesResponse AWS API Documentation
|
3999
|
+
#
|
4000
|
+
class ListDataSourcesResponse < Struct.new(
|
4001
|
+
:data_sources)
|
4002
|
+
SENSITIVE = []
|
4003
|
+
include Aws::Structure
|
4004
|
+
end
|
4005
|
+
|
4006
|
+
# Container for the parameters to the `ListDomainMaintenances`
|
4007
|
+
# operation.
|
4008
|
+
#
|
4009
|
+
# @!attribute [rw] domain_name
|
4010
|
+
# The name of the domain.
|
4011
|
+
# @return [String]
|
4012
|
+
#
|
4013
|
+
# @!attribute [rw] action
|
4014
|
+
# The name of the action.
|
4015
|
+
# @return [String]
|
4016
|
+
#
|
4017
|
+
# @!attribute [rw] status
|
4018
|
+
# The status of the action.
|
4019
|
+
# @return [String]
|
4020
|
+
#
|
4021
|
+
# @!attribute [rw] max_results
|
4022
|
+
# An optional parameter that specifies the maximum number of results
|
4023
|
+
# to return. You can use `nextToken` to get the next page of results.
|
4024
|
+
# @return [Integer]
|
4025
|
+
#
|
4026
|
+
# @!attribute [rw] next_token
|
4027
|
+
# If your initial `ListDomainMaintenances` operation returns a
|
4028
|
+
# `nextToken`, include the returned `nextToken` in subsequent
|
4029
|
+
# `ListDomainMaintenances` operations, which returns results in the
|
4030
|
+
# next page.
|
4031
|
+
# @return [String]
|
4032
|
+
#
|
4033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesRequest AWS API Documentation
|
4034
|
+
#
|
4035
|
+
class ListDomainMaintenancesRequest < Struct.new(
|
4036
|
+
:domain_name,
|
4037
|
+
:action,
|
4038
|
+
:status,
|
4039
|
+
:max_results,
|
4040
|
+
:next_token)
|
4041
|
+
SENSITIVE = []
|
4042
|
+
include Aws::Structure
|
4043
|
+
end
|
4044
|
+
|
4045
|
+
# The result of a `ListDomainMaintenances` request that contains
|
4046
|
+
# information about the requested actions.
|
4047
|
+
#
|
4048
|
+
# @!attribute [rw] domain_maintenances
|
4049
|
+
# A list of the submitted maintenance actions.
|
4050
|
+
# @return [Array<Types::DomainMaintenanceDetails>]
|
4051
|
+
#
|
4052
|
+
# @!attribute [rw] next_token
|
4053
|
+
# When `nextToken` is returned, there are more results available. The
|
4054
|
+
# value of `nextToken` is a unique pagination token for each page.
|
4055
|
+
# Send the request again using the returned token to retrieve the next
|
4056
|
+
# page.
|
4057
|
+
# @return [String]
|
4058
|
+
#
|
4059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesResponse AWS API Documentation
|
4060
|
+
#
|
4061
|
+
class ListDomainMaintenancesResponse < Struct.new(
|
4062
|
+
:domain_maintenances,
|
4063
|
+
:next_token)
|
4064
|
+
SENSITIVE = []
|
4065
|
+
include Aws::Structure
|
4066
|
+
end
|
4067
|
+
|
3502
4068
|
# Container for the parameters to the `ListDomainNames` operation.
|
3503
4069
|
#
|
3504
4070
|
# @!attribute [rw] engine_type
|
@@ -3569,7 +4135,7 @@ module Aws::OpenSearchService
|
|
3569
4135
|
# @!attribute [rw] next_token
|
3570
4136
|
# When `nextToken` is returned, there are more results available. The
|
3571
4137
|
# value of `nextToken` is a unique pagination token for each page.
|
3572
|
-
#
|
4138
|
+
# Send the request again using the returned token to retrieve the next
|
3573
4139
|
# page.
|
3574
4140
|
# @return [String]
|
3575
4141
|
#
|
@@ -3635,7 +4201,7 @@ module Aws::OpenSearchService
|
|
3635
4201
|
# @!attribute [rw] next_token
|
3636
4202
|
# When `nextToken` is returned, there are more results available. The
|
3637
4203
|
# value of `nextToken` is a unique pagination token for each page.
|
3638
|
-
#
|
4204
|
+
# Send the request again using the returned token to retrieve the next
|
3639
4205
|
# page.
|
3640
4206
|
# @return [String]
|
3641
4207
|
#
|
@@ -3688,7 +4254,7 @@ module Aws::OpenSearchService
|
|
3688
4254
|
# @!attribute [rw] next_token
|
3689
4255
|
# When `nextToken` is returned, there are more results available. The
|
3690
4256
|
# value of `nextToken` is a unique pagination token for each page.
|
3691
|
-
#
|
4257
|
+
# Send the request again using the returned token to retrieve the next
|
3692
4258
|
# page.
|
3693
4259
|
# @return [String]
|
3694
4260
|
#
|
@@ -3734,7 +4300,7 @@ module Aws::OpenSearchService
|
|
3734
4300
|
# @!attribute [rw] next_token
|
3735
4301
|
# When `nextToken` is returned, there are more results available. The
|
3736
4302
|
# value of `nextToken` is a unique pagination token for each page.
|
3737
|
-
#
|
4303
|
+
# Send the request again using the returned token to retrieve the next
|
3738
4304
|
# page.
|
3739
4305
|
# @return [String]
|
3740
4306
|
#
|
@@ -3808,7 +4374,7 @@ module Aws::OpenSearchService
|
|
3808
4374
|
# @!attribute [rw] next_token
|
3809
4375
|
# When `nextToken` is returned, there are more results available. The
|
3810
4376
|
# value of `nextToken` is a unique pagination token for each page.
|
3811
|
-
#
|
4377
|
+
# Send the request again using the returned token to retrieve the next
|
3812
4378
|
# page.
|
3813
4379
|
# @return [String]
|
3814
4380
|
#
|
@@ -3853,7 +4419,7 @@ module Aws::OpenSearchService
|
|
3853
4419
|
# @!attribute [rw] next_token
|
3854
4420
|
# When `nextToken` is returned, there are more results available. The
|
3855
4421
|
# value of `nextToken` is a unique pagination token for each page.
|
3856
|
-
#
|
4422
|
+
# Send the request again using the returned token to retrieve the next
|
3857
4423
|
# page.
|
3858
4424
|
# @return [String]
|
3859
4425
|
#
|
@@ -3893,7 +4459,7 @@ module Aws::OpenSearchService
|
|
3893
4459
|
# @!attribute [rw] next_token
|
3894
4460
|
# When `nextToken` is returned, there are more results available. The
|
3895
4461
|
# value of `nextToken` is a unique pagination token for each page.
|
3896
|
-
#
|
4462
|
+
# Send the request again using the returned token to retrieve the next
|
3897
4463
|
# page.
|
3898
4464
|
# @return [String]
|
3899
4465
|
#
|
@@ -3928,7 +4494,7 @@ module Aws::OpenSearchService
|
|
3928
4494
|
# @!attribute [rw] next_token
|
3929
4495
|
# When `nextToken` is returned, there are more results available. The
|
3930
4496
|
# value of `nextToken` is a unique pagination token for each page.
|
3931
|
-
#
|
4497
|
+
# Send the request again using the returned token to retrieve the next
|
3932
4498
|
# page.
|
3933
4499
|
# @return [String]
|
3934
4500
|
#
|
@@ -4020,6 +4586,44 @@ module Aws::OpenSearchService
|
|
4020
4586
|
include Aws::Structure
|
4021
4587
|
end
|
4022
4588
|
|
4589
|
+
# Information about the domain properties that are currently being
|
4590
|
+
# modified.
|
4591
|
+
#
|
4592
|
+
# @!attribute [rw] name
|
4593
|
+
# The name of the property that is currently being modified.
|
4594
|
+
# @return [String]
|
4595
|
+
#
|
4596
|
+
# @!attribute [rw] active_value
|
4597
|
+
# The current value of the domain property that is being modified.
|
4598
|
+
# @return [String]
|
4599
|
+
#
|
4600
|
+
# @!attribute [rw] pending_value
|
4601
|
+
# The value that the property that is currently being modified will
|
4602
|
+
# eventually have.
|
4603
|
+
# @return [String]
|
4604
|
+
#
|
4605
|
+
# @!attribute [rw] value_type
|
4606
|
+
# The type of value that is currently being modified. Properties can
|
4607
|
+
# have two types:
|
4608
|
+
#
|
4609
|
+
# * `PLAIN_TEXT`: Contain direct values such as "1", "True", or
|
4610
|
+
# "c5.large.search".
|
4611
|
+
#
|
4612
|
+
# * `STRINGIFIED_JSON`: Contain content in JSON format, such as
|
4613
|
+
# \\\{"Enabled":"True"\\}".
|
4614
|
+
# @return [String]
|
4615
|
+
#
|
4616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ModifyingProperties AWS API Documentation
|
4617
|
+
#
|
4618
|
+
class ModifyingProperties < Struct.new(
|
4619
|
+
:name,
|
4620
|
+
:active_value,
|
4621
|
+
:pending_value,
|
4622
|
+
:value_type)
|
4623
|
+
SENSITIVE = []
|
4624
|
+
include Aws::Structure
|
4625
|
+
end
|
4626
|
+
|
4023
4627
|
# Enables or disables node-to-node encryption. For more information, see
|
4024
4628
|
# [Node-to-node encryption for Amazon OpenSearch Service][1].
|
4025
4629
|
#
|
@@ -4311,6 +4915,17 @@ module Aws::OpenSearchService
|
|
4311
4915
|
# otherwise.
|
4312
4916
|
# @return [Types::ErrorDetails]
|
4313
4917
|
#
|
4918
|
+
# @!attribute [rw] engine_version
|
4919
|
+
# Version of OpenSearch or Elasticsearch, in the format
|
4920
|
+
# Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
|
4921
|
+
# version of OpenSearch.
|
4922
|
+
# @return [String]
|
4923
|
+
#
|
4924
|
+
# @!attribute [rw] available_plugin_properties
|
4925
|
+
# If the package is a `ZIP-PLUGIN` package, additional information
|
4926
|
+
# about plugin properties.
|
4927
|
+
# @return [Types::PluginProperties]
|
4928
|
+
#
|
4314
4929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageDetails AWS API Documentation
|
4315
4930
|
#
|
4316
4931
|
class PackageDetails < Struct.new(
|
@@ -4322,7 +4937,9 @@ module Aws::OpenSearchService
|
|
4322
4937
|
:created_at,
|
4323
4938
|
:last_updated_at,
|
4324
4939
|
:available_package_version,
|
4325
|
-
:error_details
|
4940
|
+
:error_details,
|
4941
|
+
:engine_version,
|
4942
|
+
:available_plugin_properties)
|
4326
4943
|
SENSITIVE = []
|
4327
4944
|
include Aws::Structure
|
4328
4945
|
end
|
@@ -4360,12 +4977,52 @@ module Aws::OpenSearchService
|
|
4360
4977
|
# The date and time when the package was created.
|
4361
4978
|
# @return [Time]
|
4362
4979
|
#
|
4980
|
+
# @!attribute [rw] plugin_properties
|
4981
|
+
# Additional information about plugin properties if the package is a
|
4982
|
+
# `ZIP-PLUGIN` package.
|
4983
|
+
# @return [Types::PluginProperties]
|
4984
|
+
#
|
4363
4985
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageVersionHistory AWS API Documentation
|
4364
4986
|
#
|
4365
4987
|
class PackageVersionHistory < Struct.new(
|
4366
4988
|
:package_version,
|
4367
4989
|
:commit_message,
|
4368
|
-
:created_at
|
4990
|
+
:created_at,
|
4991
|
+
:plugin_properties)
|
4992
|
+
SENSITIVE = []
|
4993
|
+
include Aws::Structure
|
4994
|
+
end
|
4995
|
+
|
4996
|
+
# Basic information about the plugin.
|
4997
|
+
#
|
4998
|
+
# @!attribute [rw] name
|
4999
|
+
# The name of the plugin.
|
5000
|
+
# @return [String]
|
5001
|
+
#
|
5002
|
+
# @!attribute [rw] description
|
5003
|
+
# The description of the plugin.
|
5004
|
+
# @return [String]
|
5005
|
+
#
|
5006
|
+
# @!attribute [rw] version
|
5007
|
+
# The version of the plugin.
|
5008
|
+
# @return [String]
|
5009
|
+
#
|
5010
|
+
# @!attribute [rw] class_name
|
5011
|
+
# The name of the class to load.
|
5012
|
+
# @return [String]
|
5013
|
+
#
|
5014
|
+
# @!attribute [rw] uncompressed_size_in_bytes
|
5015
|
+
# The uncompressed size of the plugin.
|
5016
|
+
# @return [Integer]
|
5017
|
+
#
|
5018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PluginProperties AWS API Documentation
|
5019
|
+
#
|
5020
|
+
class PluginProperties < Struct.new(
|
5021
|
+
:name,
|
5022
|
+
:description,
|
5023
|
+
:version,
|
5024
|
+
:class_name,
|
5025
|
+
:uncompressed_size_in_bytes)
|
4369
5026
|
SENSITIVE = []
|
4370
5027
|
include Aws::Structure
|
4371
5028
|
end
|
@@ -4655,6 +5312,20 @@ module Aws::OpenSearchService
|
|
4655
5312
|
#
|
4656
5313
|
class RevokeVpcEndpointAccessResponse < Aws::EmptyStructure; end
|
4657
5314
|
|
5315
|
+
# Information about the Amazon S3 Glue Data Catalog.
|
5316
|
+
#
|
5317
|
+
# @!attribute [rw] role_arn
|
5318
|
+
# >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
|
5319
|
+
# @return [String]
|
5320
|
+
#
|
5321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/S3GlueDataCatalog AWS API Documentation
|
5322
|
+
#
|
5323
|
+
class S3GlueDataCatalog < Struct.new(
|
5324
|
+
:role_arn)
|
5325
|
+
SENSITIVE = []
|
5326
|
+
include Aws::Structure
|
5327
|
+
end
|
5328
|
+
|
4658
5329
|
# The SAML identity povider information.
|
4659
5330
|
#
|
4660
5331
|
# @!attribute [rw] metadata_content
|
@@ -5006,6 +5677,46 @@ module Aws::OpenSearchService
|
|
5006
5677
|
include Aws::Structure
|
5007
5678
|
end
|
5008
5679
|
|
5680
|
+
# Container for the parameters to the `StartDomainMaintenance`
|
5681
|
+
# operation.
|
5682
|
+
#
|
5683
|
+
# @!attribute [rw] domain_name
|
5684
|
+
# The name of the domain.
|
5685
|
+
# @return [String]
|
5686
|
+
#
|
5687
|
+
# @!attribute [rw] action
|
5688
|
+
# The name of the action.
|
5689
|
+
# @return [String]
|
5690
|
+
#
|
5691
|
+
# @!attribute [rw] node_id
|
5692
|
+
# The ID of the data node.
|
5693
|
+
# @return [String]
|
5694
|
+
#
|
5695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceRequest AWS API Documentation
|
5696
|
+
#
|
5697
|
+
class StartDomainMaintenanceRequest < Struct.new(
|
5698
|
+
:domain_name,
|
5699
|
+
:action,
|
5700
|
+
:node_id)
|
5701
|
+
SENSITIVE = []
|
5702
|
+
include Aws::Structure
|
5703
|
+
end
|
5704
|
+
|
5705
|
+
# The result of a `StartDomainMaintenance` request that information
|
5706
|
+
# about the requested action.
|
5707
|
+
#
|
5708
|
+
# @!attribute [rw] maintenance_id
|
5709
|
+
# The request ID of requested action.
|
5710
|
+
# @return [String]
|
5711
|
+
#
|
5712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceResponse AWS API Documentation
|
5713
|
+
#
|
5714
|
+
class StartDomainMaintenanceResponse < Struct.new(
|
5715
|
+
:maintenance_id)
|
5716
|
+
SENSITIVE = []
|
5717
|
+
include Aws::Structure
|
5718
|
+
end
|
5719
|
+
|
5009
5720
|
# Container for the request parameters to the
|
5010
5721
|
# `StartServiceSoftwareUpdate` operation.
|
5011
5722
|
#
|
@@ -5154,6 +5865,54 @@ module Aws::OpenSearchService
|
|
5154
5865
|
include Aws::Structure
|
5155
5866
|
end
|
5156
5867
|
|
5868
|
+
# Container for the parameters to the `UpdateDataSource` operation.
|
5869
|
+
#
|
5870
|
+
# @!attribute [rw] domain_name
|
5871
|
+
# The name of the domain.
|
5872
|
+
# @return [String]
|
5873
|
+
#
|
5874
|
+
# @!attribute [rw] name
|
5875
|
+
# The name of the data source to modify.
|
5876
|
+
# @return [String]
|
5877
|
+
#
|
5878
|
+
# @!attribute [rw] data_source_type
|
5879
|
+
# The type of data source.
|
5880
|
+
# @return [Types::DataSourceType]
|
5881
|
+
#
|
5882
|
+
# @!attribute [rw] description
|
5883
|
+
# A new description of the data source.
|
5884
|
+
# @return [String]
|
5885
|
+
#
|
5886
|
+
# @!attribute [rw] status
|
5887
|
+
# The status of the data source update request.
|
5888
|
+
# @return [String]
|
5889
|
+
#
|
5890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceRequest AWS API Documentation
|
5891
|
+
#
|
5892
|
+
class UpdateDataSourceRequest < Struct.new(
|
5893
|
+
:domain_name,
|
5894
|
+
:name,
|
5895
|
+
:data_source_type,
|
5896
|
+
:description,
|
5897
|
+
:status)
|
5898
|
+
SENSITIVE = []
|
5899
|
+
include Aws::Structure
|
5900
|
+
end
|
5901
|
+
|
5902
|
+
# The result of an `UpdateDataSource` operation.
|
5903
|
+
#
|
5904
|
+
# @!attribute [rw] message
|
5905
|
+
# A message associated with the updated data source.
|
5906
|
+
# @return [String]
|
5907
|
+
#
|
5908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceResponse AWS API Documentation
|
5909
|
+
#
|
5910
|
+
class UpdateDataSourceResponse < Struct.new(
|
5911
|
+
:message)
|
5912
|
+
SENSITIVE = []
|
5913
|
+
include Aws::Structure
|
5914
|
+
end
|
5915
|
+
|
5157
5916
|
# Container for the request parameters to the `UpdateDomain` operation.
|
5158
5917
|
#
|
5159
5918
|
# @!attribute [rw] domain_name
|
@@ -5223,6 +5982,13 @@ module Aws::OpenSearchService
|
|
5223
5982
|
# JSON-formatted string.
|
5224
5983
|
# @return [String]
|
5225
5984
|
#
|
5985
|
+
# @!attribute [rw] ip_address_type
|
5986
|
+
# Specify either dual stack or IPv4 as your IP address type. Dual
|
5987
|
+
# stack allows you to share domain resources across IPv4 and IPv6
|
5988
|
+
# address types, and is the recommended option. If your IP address
|
5989
|
+
# type is currently set to dual stack, you can't change it.
|
5990
|
+
# @return [String]
|
5991
|
+
#
|
5226
5992
|
# @!attribute [rw] log_publishing_options
|
5227
5993
|
# Options to publish OpenSearch logs to Amazon CloudWatch Logs.
|
5228
5994
|
# @return [Hash<String,Types::LogPublishingOption>]
|
@@ -5288,6 +6054,7 @@ module Aws::OpenSearchService
|
|
5288
6054
|
:cognito_options,
|
5289
6055
|
:advanced_options,
|
5290
6056
|
:access_policies,
|
6057
|
+
:ip_address_type,
|
5291
6058
|
:log_publishing_options,
|
5292
6059
|
:encryption_at_rest_options,
|
5293
6060
|
:domain_endpoint_options,
|