aws-sdk-opensearchservice 1.61.0 → 1.63.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +263 -15
- data/lib/aws-sdk-opensearchservice/client_api.rb +149 -0
- data/lib/aws-sdk-opensearchservice/types.rb +312 -8
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +79 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +91 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b6733e23a5a357037f1dff08350f877220ee23734adc32f9df677903725e6f31
|
4
|
+
data.tar.gz: 7763825ce97f99d28a5273c7e108b3bf0be2563821b79380ea94b47d5161a286
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f46835e097e087bf26f2bab43860b4c215aaa6f64d21a55bb3f58eea3200283a9243548a1b93c2ecc885f32632b6b6b45012b5fe72409be3c9170f1ffd7f5a68
|
7
|
+
data.tar.gz: 2e27bf4508682f5bae4dc478dd6b3d5e1807f8d2706d478954639faf6bb34428c3100aa46ec05e305e3f31161355b760aedeaf4bed93ad9fd1464db0824d047e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.63.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.62.0 (2024-12-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This feature introduces support for CRUDL APIs, enabling the creation and management of Connected data sources.
|
13
|
+
|
4
14
|
1.61.0 (2024-11-11)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.63.0
|
@@ -257,11 +257,34 @@ module Aws::OpenSearchService
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -541,18 +564,81 @@ module Aws::OpenSearchService
|
|
541
564
|
req.send_request(options)
|
542
565
|
end
|
543
566
|
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
567
|
+
# Adds a new data source in Amazon OpenSearch Service so that you can
|
568
|
+
# perform direct queries on external data.
|
569
|
+
#
|
570
|
+
# @option params [required, String] :data_source_name
|
571
|
+
# A unique, user-defined label to identify the data source within your
|
572
|
+
# OpenSearch Service environment.
|
573
|
+
#
|
574
|
+
# @option params [required, Types::DirectQueryDataSourceType] :data_source_type
|
575
|
+
# The supported Amazon Web Services service that you want to use as the
|
576
|
+
# source for direct queries in OpenSearch Service.
|
577
|
+
#
|
578
|
+
# @option params [String] :description
|
579
|
+
# An optional text field for providing additional context and details
|
580
|
+
# about the data source.
|
581
|
+
#
|
582
|
+
# @option params [required, Array<String>] :open_search_arns
|
583
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch collections
|
584
|
+
# that are associated with the direct query data source.
|
585
|
+
#
|
586
|
+
# @option params [Array<Types::Tag>] :tag_list
|
587
|
+
# A list of tags attached to a domain.
|
588
|
+
#
|
589
|
+
# @return [Types::AddDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
590
|
+
#
|
591
|
+
# * {Types::AddDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
592
|
+
#
|
593
|
+
# @example Request syntax with placeholder values
|
594
|
+
#
|
595
|
+
# resp = client.add_direct_query_data_source({
|
596
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
597
|
+
# data_source_type: { # required
|
598
|
+
# cloud_watch_log: {
|
599
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
600
|
+
# },
|
601
|
+
# security_lake: {
|
602
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
603
|
+
# },
|
604
|
+
# },
|
605
|
+
# description: "DirectQueryDataSourceDescription",
|
606
|
+
# open_search_arns: ["ARN"], # required
|
607
|
+
# tag_list: [
|
608
|
+
# {
|
609
|
+
# key: "TagKey", # required
|
610
|
+
# value: "TagValue", # required
|
611
|
+
# },
|
612
|
+
# ],
|
613
|
+
# })
|
614
|
+
#
|
615
|
+
# @example Response structure
|
616
|
+
#
|
617
|
+
# resp.data_source_arn #=> String
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDirectQueryDataSource AWS API Documentation
|
620
|
+
#
|
621
|
+
# @overload add_direct_query_data_source(params = {})
|
622
|
+
# @param [Hash] params ({})
|
623
|
+
def add_direct_query_data_source(params = {}, options = {})
|
624
|
+
req = build_request(:add_direct_query_data_source, params)
|
625
|
+
req.send_request(options)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Attaches tags to an existing Amazon OpenSearch Service domain, data
|
629
|
+
# source, or application.
|
630
|
+
#
|
631
|
+
# Tags are a set of case-sensitive key-value pairs. A domain, data
|
632
|
+
# source, or application can have up to 10 tags. For more information,
|
633
|
+
# see [Tagging Amazon OpenSearch Service resources][1].
|
548
634
|
#
|
549
635
|
#
|
550
636
|
#
|
551
637
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html
|
552
638
|
#
|
553
639
|
# @option params [required, String] :arn
|
554
|
-
# Amazon Resource Name (ARN) for the OpenSearch Service domain
|
555
|
-
# you want to attach resource tags.
|
640
|
+
# Amazon Resource Name (ARN) for the OpenSearch Service domain, data
|
641
|
+
# source, or application to which you want to attach resource tags.
|
556
642
|
#
|
557
643
|
# @option params [required, Array<Types::Tag>] :tag_list
|
558
644
|
# List of resource tags.
|
@@ -1644,6 +1730,30 @@ module Aws::OpenSearchService
|
|
1644
1730
|
req.send_request(options)
|
1645
1731
|
end
|
1646
1732
|
|
1733
|
+
# Deletes a previously configured direct query data source from Amazon
|
1734
|
+
# OpenSearch Service.
|
1735
|
+
#
|
1736
|
+
# @option params [required, String] :data_source_name
|
1737
|
+
# A unique, user-defined label to identify the data source within your
|
1738
|
+
# OpenSearch Service environment.
|
1739
|
+
#
|
1740
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1741
|
+
#
|
1742
|
+
# @example Request syntax with placeholder values
|
1743
|
+
#
|
1744
|
+
# resp = client.delete_direct_query_data_source({
|
1745
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
1746
|
+
# })
|
1747
|
+
#
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDirectQueryDataSource AWS API Documentation
|
1749
|
+
#
|
1750
|
+
# @overload delete_direct_query_data_source(params = {})
|
1751
|
+
# @param [Hash] params ({})
|
1752
|
+
def delete_direct_query_data_source(params = {}, options = {})
|
1753
|
+
req = build_request(:delete_direct_query_data_source, params)
|
1754
|
+
req.send_request(options)
|
1755
|
+
end
|
1756
|
+
|
1647
1757
|
# Deletes an Amazon OpenSearch Service domain and all of its data. You
|
1648
1758
|
# can't recover a domain after you delete it.
|
1649
1759
|
#
|
@@ -3510,6 +3620,46 @@ module Aws::OpenSearchService
|
|
3510
3620
|
req.send_request(options)
|
3511
3621
|
end
|
3512
3622
|
|
3623
|
+
# Returns detailed configuration information for a specific direct query
|
3624
|
+
# data source in Amazon OpenSearch Service.
|
3625
|
+
#
|
3626
|
+
# @option params [required, String] :data_source_name
|
3627
|
+
# A unique, user-defined label that identifies the data source within
|
3628
|
+
# your OpenSearch Service environment.
|
3629
|
+
#
|
3630
|
+
# @return [Types::GetDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3631
|
+
#
|
3632
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_name #data_source_name} => String
|
3633
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_type #data_source_type} => Types::DirectQueryDataSourceType
|
3634
|
+
# * {Types::GetDirectQueryDataSourceResponse#description #description} => String
|
3635
|
+
# * {Types::GetDirectQueryDataSourceResponse#open_search_arns #open_search_arns} => Array<String>
|
3636
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
3637
|
+
#
|
3638
|
+
# @example Request syntax with placeholder values
|
3639
|
+
#
|
3640
|
+
# resp = client.get_direct_query_data_source({
|
3641
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
3642
|
+
# })
|
3643
|
+
#
|
3644
|
+
# @example Response structure
|
3645
|
+
#
|
3646
|
+
# resp.data_source_name #=> String
|
3647
|
+
# resp.data_source_type.cloud_watch_log.role_arn #=> String
|
3648
|
+
# resp.data_source_type.security_lake.role_arn #=> String
|
3649
|
+
# resp.description #=> String
|
3650
|
+
# resp.open_search_arns #=> Array
|
3651
|
+
# resp.open_search_arns[0] #=> String
|
3652
|
+
# resp.data_source_arn #=> String
|
3653
|
+
#
|
3654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDirectQueryDataSource AWS API Documentation
|
3655
|
+
#
|
3656
|
+
# @overload get_direct_query_data_source(params = {})
|
3657
|
+
# @param [Hash] params ({})
|
3658
|
+
def get_direct_query_data_source(params = {}, options = {})
|
3659
|
+
req = build_request(:get_direct_query_data_source, params)
|
3660
|
+
req.send_request(options)
|
3661
|
+
end
|
3662
|
+
|
3513
3663
|
# The status of the maintenance action.
|
3514
3664
|
#
|
3515
3665
|
# @option params [required, String] :domain_name
|
@@ -3794,6 +3944,49 @@ module Aws::OpenSearchService
|
|
3794
3944
|
req.send_request(options)
|
3795
3945
|
end
|
3796
3946
|
|
3947
|
+
# Lists an inventory of all the direct query data sources that you have
|
3948
|
+
# configured within Amazon OpenSearch Service.
|
3949
|
+
#
|
3950
|
+
# @option params [String] :next_token
|
3951
|
+
# When `nextToken` is returned, there are more results available. The
|
3952
|
+
# value of `nextToken` is a unique pagination token for each page. Send
|
3953
|
+
# the request again using the returned token to retrieve the next page.
|
3954
|
+
#
|
3955
|
+
# @return [Types::ListDirectQueryDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3956
|
+
#
|
3957
|
+
# * {Types::ListDirectQueryDataSourcesResponse#next_token #next_token} => String
|
3958
|
+
# * {Types::ListDirectQueryDataSourcesResponse#direct_query_data_sources #direct_query_data_sources} => Array<Types::DirectQueryDataSource>
|
3959
|
+
#
|
3960
|
+
# @example Request syntax with placeholder values
|
3961
|
+
#
|
3962
|
+
# resp = client.list_direct_query_data_sources({
|
3963
|
+
# next_token: "NextToken",
|
3964
|
+
# })
|
3965
|
+
#
|
3966
|
+
# @example Response structure
|
3967
|
+
#
|
3968
|
+
# resp.next_token #=> String
|
3969
|
+
# resp.direct_query_data_sources #=> Array
|
3970
|
+
# resp.direct_query_data_sources[0].data_source_name #=> String
|
3971
|
+
# resp.direct_query_data_sources[0].data_source_type.cloud_watch_log.role_arn #=> String
|
3972
|
+
# resp.direct_query_data_sources[0].data_source_type.security_lake.role_arn #=> String
|
3973
|
+
# resp.direct_query_data_sources[0].description #=> String
|
3974
|
+
# resp.direct_query_data_sources[0].open_search_arns #=> Array
|
3975
|
+
# resp.direct_query_data_sources[0].open_search_arns[0] #=> String
|
3976
|
+
# resp.direct_query_data_sources[0].data_source_arn #=> String
|
3977
|
+
# resp.direct_query_data_sources[0].tag_list #=> Array
|
3978
|
+
# resp.direct_query_data_sources[0].tag_list[0].key #=> String
|
3979
|
+
# resp.direct_query_data_sources[0].tag_list[0].value #=> String
|
3980
|
+
#
|
3981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDirectQueryDataSources AWS API Documentation
|
3982
|
+
#
|
3983
|
+
# @overload list_direct_query_data_sources(params = {})
|
3984
|
+
# @param [Hash] params ({})
|
3985
|
+
def list_direct_query_data_sources(params = {}, options = {})
|
3986
|
+
req = build_request(:list_direct_query_data_sources, params)
|
3987
|
+
req.send_request(options)
|
3988
|
+
end
|
3989
|
+
|
3797
3990
|
# A list of maintenance actions for the domain.
|
3798
3991
|
#
|
3799
3992
|
# @option params [required, String] :domain_name
|
@@ -4145,15 +4338,17 @@ module Aws::OpenSearchService
|
|
4145
4338
|
req.send_request(options)
|
4146
4339
|
end
|
4147
4340
|
|
4148
|
-
# Returns all resource tags for an Amazon OpenSearch Service domain
|
4149
|
-
# more information, see [Tagging Amazon
|
4341
|
+
# Returns all resource tags for an Amazon OpenSearch Service domain,
|
4342
|
+
# data source, or application. For more information, see [Tagging Amazon
|
4343
|
+
# OpenSearch Service resources][1].
|
4150
4344
|
#
|
4151
4345
|
#
|
4152
4346
|
#
|
4153
4347
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html
|
4154
4348
|
#
|
4155
4349
|
# @option params [required, String] :arn
|
4156
|
-
# Amazon Resource Name (ARN) for the domain
|
4350
|
+
# Amazon Resource Name (ARN) for the domain, data source, or application
|
4351
|
+
# to view tags for.
|
4157
4352
|
#
|
4158
4353
|
# @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4159
4354
|
#
|
@@ -4419,19 +4614,20 @@ module Aws::OpenSearchService
|
|
4419
4614
|
end
|
4420
4615
|
|
4421
4616
|
# Removes the specified set of tags from an Amazon OpenSearch Service
|
4422
|
-
# domain. For more information, see [
|
4423
|
-
#
|
4617
|
+
# domain, data source, or application. For more information, see [
|
4618
|
+
# Tagging Amazon OpenSearch Service resources][1].
|
4424
4619
|
#
|
4425
4620
|
#
|
4426
4621
|
#
|
4427
4622
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
|
4428
4623
|
#
|
4429
4624
|
# @option params [required, String] :arn
|
4430
|
-
# The Amazon Resource Name (ARN) of the domain
|
4431
|
-
# delete the specified tags.
|
4625
|
+
# The Amazon Resource Name (ARN) of the domain, data source, or
|
4626
|
+
# application from which you want to delete the specified tags.
|
4432
4627
|
#
|
4433
4628
|
# @option params [required, Array<String>] :tag_keys
|
4434
|
-
# The list of tag keys to remove from the domain
|
4629
|
+
# The list of tag keys to remove from the domain, data source, or
|
4630
|
+
# application.
|
4435
4631
|
#
|
4436
4632
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4437
4633
|
#
|
@@ -4708,6 +4904,58 @@ module Aws::OpenSearchService
|
|
4708
4904
|
req.send_request(options)
|
4709
4905
|
end
|
4710
4906
|
|
4907
|
+
# Updates the configuration or properties of an existing direct query
|
4908
|
+
# data source in Amazon OpenSearch Service.
|
4909
|
+
#
|
4910
|
+
# @option params [required, String] :data_source_name
|
4911
|
+
# A unique, user-defined label to identify the data source within your
|
4912
|
+
# OpenSearch Service environment.
|
4913
|
+
#
|
4914
|
+
# @option params [required, Types::DirectQueryDataSourceType] :data_source_type
|
4915
|
+
# The supported Amazon Web Services service that you want to use as the
|
4916
|
+
# source for direct queries in OpenSearch Service.
|
4917
|
+
#
|
4918
|
+
# @option params [String] :description
|
4919
|
+
# An optional text field for providing additional context and details
|
4920
|
+
# about the data source.
|
4921
|
+
#
|
4922
|
+
# @option params [required, Array<String>] :open_search_arns
|
4923
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch collections
|
4924
|
+
# that are associated with the direct query data source.
|
4925
|
+
#
|
4926
|
+
# @return [Types::UpdateDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4927
|
+
#
|
4928
|
+
# * {Types::UpdateDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
4929
|
+
#
|
4930
|
+
# @example Request syntax with placeholder values
|
4931
|
+
#
|
4932
|
+
# resp = client.update_direct_query_data_source({
|
4933
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
4934
|
+
# data_source_type: { # required
|
4935
|
+
# cloud_watch_log: {
|
4936
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
4937
|
+
# },
|
4938
|
+
# security_lake: {
|
4939
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
4940
|
+
# },
|
4941
|
+
# },
|
4942
|
+
# description: "DirectQueryDataSourceDescription",
|
4943
|
+
# open_search_arns: ["ARN"], # required
|
4944
|
+
# })
|
4945
|
+
#
|
4946
|
+
# @example Response structure
|
4947
|
+
#
|
4948
|
+
# resp.data_source_arn #=> String
|
4949
|
+
#
|
4950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDirectQueryDataSource AWS API Documentation
|
4951
|
+
#
|
4952
|
+
# @overload update_direct_query_data_source(params = {})
|
4953
|
+
# @param [Hash] params ({})
|
4954
|
+
def update_direct_query_data_source(params = {}, options = {})
|
4955
|
+
req = build_request(:update_direct_query_data_source, params)
|
4956
|
+
req.send_request(options)
|
4957
|
+
end
|
4958
|
+
|
4711
4959
|
# Modifies the cluster configuration of the specified Amazon OpenSearch
|
4712
4960
|
# Service domain.
|
4713
4961
|
#
|
@@ -5539,7 +5787,7 @@ module Aws::OpenSearchService
|
|
5539
5787
|
tracer: tracer
|
5540
5788
|
)
|
5541
5789
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
5542
|
-
context[:gem_version] = '1.
|
5790
|
+
context[:gem_version] = '1.63.0'
|
5543
5791
|
Seahorse::Client::Request.new(handlers, context)
|
5544
5792
|
end
|
5545
5793
|
|