aws-sdk-opensearchservice 1.58.0 → 1.59.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +376 -5
- data/lib/aws-sdk-opensearchservice/client_api.rb +236 -2
- data/lib/aws-sdk-opensearchservice/types.rb +615 -2
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +127 -2
- data/sig/types.rbs +149 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f163aae155ded0e58b3f4e6f0ea694b0479af76012419a201f57da40e62d4d21
|
4
|
+
data.tar.gz: 3e1c1379665aedcae7e60f6085fab4ad7274a156200e5fdb2527c3c92e576b7a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8586a7b3a22f3d6adf3adde9b587485e3f824c4df8718800c3242bbdc0f9254c5882aeacce1029751f40d9fd7942ba844b91dbcf934d0cdfbc53cf20632d2a82
|
7
|
+
data.tar.gz: 9d5483a4595b50d5b5bb2b8e2cac2b481fc858b16e76fd15686843d42e0be348c4ac32641909bb596402111410727581f2b692d6beb6a3336f3637c04319dceb
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.59.0 (2024-10-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces the new OpenSearch user interface (Dashboards), a new web-based application that can be associated with multiple data sources across OpenSearch managed clusters, serverless collections, and Amazon S3, so that users can gain a comprehensive insights in an unified interface.
|
8
|
+
|
4
9
|
1.58.0 (2024-10-28)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.59.0
|
@@ -634,9 +634,12 @@ module Aws::OpenSearchService
|
|
634
634
|
# @option params [required, String] :domain_name
|
635
635
|
# The name of the OpenSearch Service domain to provide access to.
|
636
636
|
#
|
637
|
-
# @option params [
|
637
|
+
# @option params [String] :account
|
638
638
|
# The Amazon Web Services account ID to grant access to.
|
639
639
|
#
|
640
|
+
# @option params [String] :service
|
641
|
+
# The Amazon Web Services service SP to grant access to.
|
642
|
+
#
|
640
643
|
# @return [Types::AuthorizeVpcEndpointAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
641
644
|
#
|
642
645
|
# * {Types::AuthorizeVpcEndpointAccessResponse#authorized_principal #authorized_principal} => Types::AuthorizedPrincipal
|
@@ -645,7 +648,8 @@ module Aws::OpenSearchService
|
|
645
648
|
#
|
646
649
|
# resp = client.authorize_vpc_endpoint_access({
|
647
650
|
# domain_name: "DomainName", # required
|
648
|
-
# account: "AWSAccount",
|
651
|
+
# account: "AWSAccount",
|
652
|
+
# service: "application.opensearchservice.amazonaws.com", # accepts application.opensearchservice.amazonaws.com
|
649
653
|
# })
|
650
654
|
#
|
651
655
|
# @example Response structure
|
@@ -750,6 +754,103 @@ module Aws::OpenSearchService
|
|
750
754
|
req.send_request(options)
|
751
755
|
end
|
752
756
|
|
757
|
+
# Creates an OpenSearch Application.
|
758
|
+
#
|
759
|
+
# @option params [String] :client_token
|
760
|
+
# A unique client idempotency token. It will be auto generated if not
|
761
|
+
# provided.
|
762
|
+
#
|
763
|
+
# **A suitable default value is auto-generated.** You should normally
|
764
|
+
# not need to pass this option.**
|
765
|
+
#
|
766
|
+
# @option params [required, String] :name
|
767
|
+
# Name of the OpenSearch Appication to create. Application names are
|
768
|
+
# unique across the applications owned by an account within an Amazon
|
769
|
+
# Web Services Region.
|
770
|
+
#
|
771
|
+
# @option params [Array<Types::DataSource>] :data_sources
|
772
|
+
# Data sources to be associated with the OpenSearch Application.
|
773
|
+
#
|
774
|
+
# @option params [Types::IamIdentityCenterOptionsInput] :iam_identity_center_options
|
775
|
+
# Settings of IAM Identity Center for the OpenSearch Application.
|
776
|
+
#
|
777
|
+
# @option params [Array<Types::AppConfig>] :app_configs
|
778
|
+
# Configurations of the OpenSearch Application, inlcuding admin
|
779
|
+
# configuration.
|
780
|
+
#
|
781
|
+
# @option params [Array<Types::Tag>] :tag_list
|
782
|
+
# A list of tags attached to a domain.
|
783
|
+
#
|
784
|
+
# @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
785
|
+
#
|
786
|
+
# * {Types::CreateApplicationResponse#id #id} => String
|
787
|
+
# * {Types::CreateApplicationResponse#name #name} => String
|
788
|
+
# * {Types::CreateApplicationResponse#arn #arn} => String
|
789
|
+
# * {Types::CreateApplicationResponse#data_sources #data_sources} => Array<Types::DataSource>
|
790
|
+
# * {Types::CreateApplicationResponse#iam_identity_center_options #iam_identity_center_options} => Types::IamIdentityCenterOptions
|
791
|
+
# * {Types::CreateApplicationResponse#app_configs #app_configs} => Array<Types::AppConfig>
|
792
|
+
# * {Types::CreateApplicationResponse#tag_list #tag_list} => Array<Types::Tag>
|
793
|
+
# * {Types::CreateApplicationResponse#created_at #created_at} => Time
|
794
|
+
#
|
795
|
+
# @example Request syntax with placeholder values
|
796
|
+
#
|
797
|
+
# resp = client.create_application({
|
798
|
+
# client_token: "ClientToken",
|
799
|
+
# name: "ApplicationName", # required
|
800
|
+
# data_sources: [
|
801
|
+
# {
|
802
|
+
# data_source_arn: "ARN",
|
803
|
+
# data_source_description: "DataSourceDescription",
|
804
|
+
# },
|
805
|
+
# ],
|
806
|
+
# iam_identity_center_options: {
|
807
|
+
# enabled: false,
|
808
|
+
# iam_identity_center_instance_arn: "ARN",
|
809
|
+
# iam_role_for_identity_center_application_arn: "RoleArn",
|
810
|
+
# },
|
811
|
+
# app_configs: [
|
812
|
+
# {
|
813
|
+
# key: "opensearchDashboards.dashboardAdmin.users", # accepts opensearchDashboards.dashboardAdmin.users, opensearchDashboards.dashboardAdmin.groups
|
814
|
+
# value: "AppConfigValue",
|
815
|
+
# },
|
816
|
+
# ],
|
817
|
+
# tag_list: [
|
818
|
+
# {
|
819
|
+
# key: "TagKey", # required
|
820
|
+
# value: "TagValue", # required
|
821
|
+
# },
|
822
|
+
# ],
|
823
|
+
# })
|
824
|
+
#
|
825
|
+
# @example Response structure
|
826
|
+
#
|
827
|
+
# resp.id #=> String
|
828
|
+
# resp.name #=> String
|
829
|
+
# resp.arn #=> String
|
830
|
+
# resp.data_sources #=> Array
|
831
|
+
# resp.data_sources[0].data_source_arn #=> String
|
832
|
+
# resp.data_sources[0].data_source_description #=> String
|
833
|
+
# resp.iam_identity_center_options.enabled #=> Boolean
|
834
|
+
# resp.iam_identity_center_options.iam_identity_center_instance_arn #=> String
|
835
|
+
# resp.iam_identity_center_options.iam_role_for_identity_center_application_arn #=> String
|
836
|
+
# resp.iam_identity_center_options.iam_identity_center_application_arn #=> String
|
837
|
+
# resp.app_configs #=> Array
|
838
|
+
# resp.app_configs[0].key #=> String, one of "opensearchDashboards.dashboardAdmin.users", "opensearchDashboards.dashboardAdmin.groups"
|
839
|
+
# resp.app_configs[0].value #=> String
|
840
|
+
# resp.tag_list #=> Array
|
841
|
+
# resp.tag_list[0].key #=> String
|
842
|
+
# resp.tag_list[0].value #=> String
|
843
|
+
# resp.created_at #=> Time
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateApplication AWS API Documentation
|
846
|
+
#
|
847
|
+
# @overload create_application(params = {})
|
848
|
+
# @param [Hash] params ({})
|
849
|
+
def create_application(params = {}, options = {})
|
850
|
+
req = build_request(:create_application, params)
|
851
|
+
req.send_request(options)
|
852
|
+
end
|
853
|
+
|
753
854
|
# Creates an Amazon OpenSearch Service domain. For more information, see
|
754
855
|
# [Creating and managing Amazon OpenSearch Service domains][1].
|
755
856
|
#
|
@@ -861,6 +962,9 @@ module Aws::OpenSearchService
|
|
861
962
|
# @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
|
862
963
|
# Options for fine-grained access control.
|
863
964
|
#
|
965
|
+
# @option params [Types::IdentityCenterOptionsInput] :identity_center_options
|
966
|
+
# Options for IAM Identity Center Option control for the domain.
|
967
|
+
#
|
864
968
|
# @option params [Array<Types::Tag>] :tag_list
|
865
969
|
# List of tags to add to the domain upon creation.
|
866
970
|
#
|
@@ -991,6 +1095,12 @@ module Aws::OpenSearchService
|
|
991
1095
|
# },
|
992
1096
|
# anonymous_auth_enabled: false,
|
993
1097
|
# },
|
1098
|
+
# identity_center_options: {
|
1099
|
+
# enabled_api_access: false,
|
1100
|
+
# identity_center_instance_arn: "IdentityCenterInstanceARN",
|
1101
|
+
# subject_key: "UserName", # accepts UserName, UserId, Email
|
1102
|
+
# roles_key: "GroupName", # accepts GroupName, GroupId
|
1103
|
+
# },
|
994
1104
|
# tag_list: [
|
995
1105
|
# {
|
996
1106
|
# key: "TagKey", # required
|
@@ -1116,6 +1226,12 @@ module Aws::OpenSearchService
|
|
1116
1226
|
# resp.domain_status.advanced_security_options.jwt_options.public_key #=> String
|
1117
1227
|
# resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
|
1118
1228
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1229
|
+
# resp.domain_status.identity_center_options.enabled_api_access #=> Boolean
|
1230
|
+
# resp.domain_status.identity_center_options.identity_center_instance_arn #=> String
|
1231
|
+
# resp.domain_status.identity_center_options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
1232
|
+
# resp.domain_status.identity_center_options.roles_key #=> String, one of "GroupName", "GroupId"
|
1233
|
+
# resp.domain_status.identity_center_options.identity_center_application_arn #=> String
|
1234
|
+
# resp.domain_status.identity_center_options.identity_store_id #=> String
|
1119
1235
|
# resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
|
1120
1236
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
1121
1237
|
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
@@ -1349,6 +1465,29 @@ module Aws::OpenSearchService
|
|
1349
1465
|
req.send_request(options)
|
1350
1466
|
end
|
1351
1467
|
|
1468
|
+
# Deletes an existing OpenSearch Application.
|
1469
|
+
#
|
1470
|
+
# @option params [required, String] :id
|
1471
|
+
# Unique identifier for the OpenSearch Application that you want to
|
1472
|
+
# delete.
|
1473
|
+
#
|
1474
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1475
|
+
#
|
1476
|
+
# @example Request syntax with placeholder values
|
1477
|
+
#
|
1478
|
+
# resp = client.delete_application({
|
1479
|
+
# id: "Id", # required
|
1480
|
+
# })
|
1481
|
+
#
|
1482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteApplication AWS API Documentation
|
1483
|
+
#
|
1484
|
+
# @overload delete_application(params = {})
|
1485
|
+
# @param [Hash] params ({})
|
1486
|
+
def delete_application(params = {}, options = {})
|
1487
|
+
req = build_request(:delete_application, params)
|
1488
|
+
req.send_request(options)
|
1489
|
+
end
|
1490
|
+
|
1352
1491
|
# Deletes a direct-query data source. For more information, see
|
1353
1492
|
# [Deleting an Amazon OpenSearch Service data source with Amazon S3][1].
|
1354
1493
|
#
|
@@ -1488,6 +1627,12 @@ module Aws::OpenSearchService
|
|
1488
1627
|
# resp.domain_status.advanced_security_options.jwt_options.public_key #=> String
|
1489
1628
|
# resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
|
1490
1629
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1630
|
+
# resp.domain_status.identity_center_options.enabled_api_access #=> Boolean
|
1631
|
+
# resp.domain_status.identity_center_options.identity_center_instance_arn #=> String
|
1632
|
+
# resp.domain_status.identity_center_options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
1633
|
+
# resp.domain_status.identity_center_options.roles_key #=> String, one of "GroupName", "GroupId"
|
1634
|
+
# resp.domain_status.identity_center_options.identity_center_application_arn #=> String
|
1635
|
+
# resp.domain_status.identity_center_options.identity_store_id #=> String
|
1491
1636
|
# resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
|
1492
1637
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
1493
1638
|
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
@@ -1793,6 +1938,12 @@ module Aws::OpenSearchService
|
|
1793
1938
|
# resp.domain_status.advanced_security_options.jwt_options.public_key #=> String
|
1794
1939
|
# resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
|
1795
1940
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1941
|
+
# resp.domain_status.identity_center_options.enabled_api_access #=> Boolean
|
1942
|
+
# resp.domain_status.identity_center_options.identity_center_instance_arn #=> String
|
1943
|
+
# resp.domain_status.identity_center_options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
1944
|
+
# resp.domain_status.identity_center_options.roles_key #=> String, one of "GroupName", "GroupId"
|
1945
|
+
# resp.domain_status.identity_center_options.identity_center_application_arn #=> String
|
1946
|
+
# resp.domain_status.identity_center_options.identity_store_id #=> String
|
1796
1947
|
# resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
|
1797
1948
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
1798
1949
|
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
@@ -2086,6 +2237,17 @@ module Aws::OpenSearchService
|
|
2086
2237
|
# resp.domain_config.advanced_security_options.status.update_version #=> Integer
|
2087
2238
|
# resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
2088
2239
|
# resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
|
2240
|
+
# resp.domain_config.identity_center_options.options.enabled_api_access #=> Boolean
|
2241
|
+
# resp.domain_config.identity_center_options.options.identity_center_instance_arn #=> String
|
2242
|
+
# resp.domain_config.identity_center_options.options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
2243
|
+
# resp.domain_config.identity_center_options.options.roles_key #=> String, one of "GroupName", "GroupId"
|
2244
|
+
# resp.domain_config.identity_center_options.options.identity_center_application_arn #=> String
|
2245
|
+
# resp.domain_config.identity_center_options.options.identity_store_id #=> String
|
2246
|
+
# resp.domain_config.identity_center_options.status.creation_date #=> Time
|
2247
|
+
# resp.domain_config.identity_center_options.status.update_date #=> Time
|
2248
|
+
# resp.domain_config.identity_center_options.status.update_version #=> Integer
|
2249
|
+
# resp.domain_config.identity_center_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
2250
|
+
# resp.domain_config.identity_center_options.status.pending_deletion #=> Boolean
|
2089
2251
|
# resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
|
2090
2252
|
# resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
|
2091
2253
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
|
@@ -2345,6 +2507,12 @@ module Aws::OpenSearchService
|
|
2345
2507
|
# resp.domain_status_list[0].advanced_security_options.jwt_options.public_key #=> String
|
2346
2508
|
# resp.domain_status_list[0].advanced_security_options.anonymous_auth_disable_date #=> Time
|
2347
2509
|
# resp.domain_status_list[0].advanced_security_options.anonymous_auth_enabled #=> Boolean
|
2510
|
+
# resp.domain_status_list[0].identity_center_options.enabled_api_access #=> Boolean
|
2511
|
+
# resp.domain_status_list[0].identity_center_options.identity_center_instance_arn #=> String
|
2512
|
+
# resp.domain_status_list[0].identity_center_options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
2513
|
+
# resp.domain_status_list[0].identity_center_options.roles_key #=> String, one of "GroupName", "GroupId"
|
2514
|
+
# resp.domain_status_list[0].identity_center_options.identity_center_application_arn #=> String
|
2515
|
+
# resp.domain_status_list[0].identity_center_options.identity_store_id #=> String
|
2348
2516
|
# resp.domain_status_list[0].auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
|
2349
2517
|
# resp.domain_status_list[0].auto_tune_options.error_message #=> String
|
2350
2518
|
# resp.domain_status_list[0].auto_tune_options.use_off_peak_window #=> Boolean
|
@@ -2502,6 +2670,12 @@ module Aws::OpenSearchService
|
|
2502
2670
|
# resp.dry_run_config.advanced_security_options.jwt_options.public_key #=> String
|
2503
2671
|
# resp.dry_run_config.advanced_security_options.anonymous_auth_disable_date #=> Time
|
2504
2672
|
# resp.dry_run_config.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
2673
|
+
# resp.dry_run_config.identity_center_options.enabled_api_access #=> Boolean
|
2674
|
+
# resp.dry_run_config.identity_center_options.identity_center_instance_arn #=> String
|
2675
|
+
# resp.dry_run_config.identity_center_options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
2676
|
+
# resp.dry_run_config.identity_center_options.roles_key #=> String, one of "GroupName", "GroupId"
|
2677
|
+
# resp.dry_run_config.identity_center_options.identity_center_application_arn #=> String
|
2678
|
+
# resp.dry_run_config.identity_center_options.identity_store_id #=> String
|
2505
2679
|
# resp.dry_run_config.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
|
2506
2680
|
# resp.dry_run_config.auto_tune_options.error_message #=> String
|
2507
2681
|
# resp.dry_run_config.auto_tune_options.use_off_peak_window #=> Boolean
|
@@ -3020,6 +3194,60 @@ module Aws::OpenSearchService
|
|
3020
3194
|
req.send_request(options)
|
3021
3195
|
end
|
3022
3196
|
|
3197
|
+
# Check the configuration and status of an existing OpenSearch
|
3198
|
+
# Application.
|
3199
|
+
#
|
3200
|
+
# @option params [required, String] :id
|
3201
|
+
# Unique identifier of the checked OpenSearch Application.
|
3202
|
+
#
|
3203
|
+
# @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3204
|
+
#
|
3205
|
+
# * {Types::GetApplicationResponse#id #id} => String
|
3206
|
+
# * {Types::GetApplicationResponse#arn #arn} => String
|
3207
|
+
# * {Types::GetApplicationResponse#name #name} => String
|
3208
|
+
# * {Types::GetApplicationResponse#endpoint #endpoint} => String
|
3209
|
+
# * {Types::GetApplicationResponse#status #status} => String
|
3210
|
+
# * {Types::GetApplicationResponse#iam_identity_center_options #iam_identity_center_options} => Types::IamIdentityCenterOptions
|
3211
|
+
# * {Types::GetApplicationResponse#data_sources #data_sources} => Array<Types::DataSource>
|
3212
|
+
# * {Types::GetApplicationResponse#app_configs #app_configs} => Array<Types::AppConfig>
|
3213
|
+
# * {Types::GetApplicationResponse#created_at #created_at} => Time
|
3214
|
+
# * {Types::GetApplicationResponse#last_updated_at #last_updated_at} => Time
|
3215
|
+
#
|
3216
|
+
# @example Request syntax with placeholder values
|
3217
|
+
#
|
3218
|
+
# resp = client.get_application({
|
3219
|
+
# id: "Id", # required
|
3220
|
+
# })
|
3221
|
+
#
|
3222
|
+
# @example Response structure
|
3223
|
+
#
|
3224
|
+
# resp.id #=> String
|
3225
|
+
# resp.arn #=> String
|
3226
|
+
# resp.name #=> String
|
3227
|
+
# resp.endpoint #=> String
|
3228
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
3229
|
+
# resp.iam_identity_center_options.enabled #=> Boolean
|
3230
|
+
# resp.iam_identity_center_options.iam_identity_center_instance_arn #=> String
|
3231
|
+
# resp.iam_identity_center_options.iam_role_for_identity_center_application_arn #=> String
|
3232
|
+
# resp.iam_identity_center_options.iam_identity_center_application_arn #=> String
|
3233
|
+
# resp.data_sources #=> Array
|
3234
|
+
# resp.data_sources[0].data_source_arn #=> String
|
3235
|
+
# resp.data_sources[0].data_source_description #=> String
|
3236
|
+
# resp.app_configs #=> Array
|
3237
|
+
# resp.app_configs[0].key #=> String, one of "opensearchDashboards.dashboardAdmin.users", "opensearchDashboards.dashboardAdmin.groups"
|
3238
|
+
# resp.app_configs[0].value #=> String
|
3239
|
+
# resp.created_at #=> Time
|
3240
|
+
# resp.last_updated_at #=> Time
|
3241
|
+
#
|
3242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetApplication AWS API Documentation
|
3243
|
+
#
|
3244
|
+
# @overload get_application(params = {})
|
3245
|
+
# @param [Hash] params ({})
|
3246
|
+
def get_application(params = {}, options = {})
|
3247
|
+
req = build_request(:get_application, params)
|
3248
|
+
req.send_request(options)
|
3249
|
+
end
|
3250
|
+
|
3023
3251
|
# Returns a map of OpenSearch or Elasticsearch versions and the versions
|
3024
3252
|
# you can upgrade them to.
|
3025
3253
|
#
|
@@ -3281,6 +3509,58 @@ module Aws::OpenSearchService
|
|
3281
3509
|
req.send_request(options)
|
3282
3510
|
end
|
3283
3511
|
|
3512
|
+
# List all OpenSearch Applications under your account.
|
3513
|
+
#
|
3514
|
+
# @option params [String] :next_token
|
3515
|
+
# When `nextToken` is returned, there are more results available. The
|
3516
|
+
# value of `nextToken` is a unique pagination token for each page. Send
|
3517
|
+
# the request again using the returned token to retrieve the next page.
|
3518
|
+
#
|
3519
|
+
# @option params [Array<String>] :statuses
|
3520
|
+
# OpenSearch Application Status can be used as filters for the listing
|
3521
|
+
# request. Possible values are `CREATING`, `UPDATING`, `DELETING`,
|
3522
|
+
# `FAILED`, `ACTIVE`, and `DELETED`.
|
3523
|
+
#
|
3524
|
+
# @option params [Integer] :max_results
|
3525
|
+
# An optional parameter that specifies the maximum number of results to
|
3526
|
+
# return for a given request.
|
3527
|
+
#
|
3528
|
+
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3529
|
+
#
|
3530
|
+
# * {Types::ListApplicationsResponse#application_summaries #application_summaries} => Array<Types::ApplicationSummary>
|
3531
|
+
# * {Types::ListApplicationsResponse#next_token #next_token} => String
|
3532
|
+
#
|
3533
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3534
|
+
#
|
3535
|
+
# @example Request syntax with placeholder values
|
3536
|
+
#
|
3537
|
+
# resp = client.list_applications({
|
3538
|
+
# next_token: "NextToken",
|
3539
|
+
# statuses: ["CREATING"], # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
|
3540
|
+
# max_results: 1,
|
3541
|
+
# })
|
3542
|
+
#
|
3543
|
+
# @example Response structure
|
3544
|
+
#
|
3545
|
+
# resp.application_summaries #=> Array
|
3546
|
+
# resp.application_summaries[0].id #=> String
|
3547
|
+
# resp.application_summaries[0].arn #=> String
|
3548
|
+
# resp.application_summaries[0].name #=> String
|
3549
|
+
# resp.application_summaries[0].endpoint #=> String
|
3550
|
+
# resp.application_summaries[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
3551
|
+
# resp.application_summaries[0].created_at #=> Time
|
3552
|
+
# resp.application_summaries[0].last_updated_at #=> Time
|
3553
|
+
# resp.next_token #=> String
|
3554
|
+
#
|
3555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListApplications AWS API Documentation
|
3556
|
+
#
|
3557
|
+
# @overload list_applications(params = {})
|
3558
|
+
# @param [Hash] params ({})
|
3559
|
+
def list_applications(params = {}, options = {})
|
3560
|
+
req = build_request(:list_applications, params)
|
3561
|
+
req.send_request(options)
|
3562
|
+
end
|
3563
|
+
|
3284
3564
|
# Lists direct-query data sources for a specific domain. For more
|
3285
3565
|
# information, see For more information, see [Working with Amazon
|
3286
3566
|
# OpenSearch Service direct queries with Amazon S3][1].
|
@@ -3974,16 +4254,20 @@ module Aws::OpenSearchService
|
|
3974
4254
|
# @option params [required, String] :domain_name
|
3975
4255
|
# The name of the OpenSearch Service domain.
|
3976
4256
|
#
|
3977
|
-
# @option params [
|
4257
|
+
# @option params [String] :account
|
3978
4258
|
# The account ID to revoke access from.
|
3979
4259
|
#
|
4260
|
+
# @option params [String] :service
|
4261
|
+
# The service SP to revoke access from.
|
4262
|
+
#
|
3980
4263
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3981
4264
|
#
|
3982
4265
|
# @example Request syntax with placeholder values
|
3983
4266
|
#
|
3984
4267
|
# resp = client.revoke_vpc_endpoint_access({
|
3985
4268
|
# domain_name: "DomainName", # required
|
3986
|
-
# account: "AWSAccount",
|
4269
|
+
# account: "AWSAccount",
|
4270
|
+
# service: "application.opensearchservice.amazonaws.com", # accepts application.opensearchservice.amazonaws.com
|
3987
4271
|
# })
|
3988
4272
|
#
|
3989
4273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RevokeVpcEndpointAccess AWS API Documentation
|
@@ -4100,6 +4384,73 @@ module Aws::OpenSearchService
|
|
4100
4384
|
req.send_request(options)
|
4101
4385
|
end
|
4102
4386
|
|
4387
|
+
# Update the OpenSearch Application.
|
4388
|
+
#
|
4389
|
+
# @option params [required, String] :id
|
4390
|
+
# Unique identifier of the OpenSearch Application to be updated.
|
4391
|
+
#
|
4392
|
+
# @option params [Array<Types::DataSource>] :data_sources
|
4393
|
+
# Data sources to be associated with the OpenSearch Application.
|
4394
|
+
#
|
4395
|
+
# @option params [Array<Types::AppConfig>] :app_configs
|
4396
|
+
# Configurations to be changed for the OpenSearch Application.
|
4397
|
+
#
|
4398
|
+
# @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4399
|
+
#
|
4400
|
+
# * {Types::UpdateApplicationResponse#id #id} => String
|
4401
|
+
# * {Types::UpdateApplicationResponse#name #name} => String
|
4402
|
+
# * {Types::UpdateApplicationResponse#arn #arn} => String
|
4403
|
+
# * {Types::UpdateApplicationResponse#data_sources #data_sources} => Array<Types::DataSource>
|
4404
|
+
# * {Types::UpdateApplicationResponse#iam_identity_center_options #iam_identity_center_options} => Types::IamIdentityCenterOptions
|
4405
|
+
# * {Types::UpdateApplicationResponse#app_configs #app_configs} => Array<Types::AppConfig>
|
4406
|
+
# * {Types::UpdateApplicationResponse#created_at #created_at} => Time
|
4407
|
+
# * {Types::UpdateApplicationResponse#last_updated_at #last_updated_at} => Time
|
4408
|
+
#
|
4409
|
+
# @example Request syntax with placeholder values
|
4410
|
+
#
|
4411
|
+
# resp = client.update_application({
|
4412
|
+
# id: "Id", # required
|
4413
|
+
# data_sources: [
|
4414
|
+
# {
|
4415
|
+
# data_source_arn: "ARN",
|
4416
|
+
# data_source_description: "DataSourceDescription",
|
4417
|
+
# },
|
4418
|
+
# ],
|
4419
|
+
# app_configs: [
|
4420
|
+
# {
|
4421
|
+
# key: "opensearchDashboards.dashboardAdmin.users", # accepts opensearchDashboards.dashboardAdmin.users, opensearchDashboards.dashboardAdmin.groups
|
4422
|
+
# value: "AppConfigValue",
|
4423
|
+
# },
|
4424
|
+
# ],
|
4425
|
+
# })
|
4426
|
+
#
|
4427
|
+
# @example Response structure
|
4428
|
+
#
|
4429
|
+
# resp.id #=> String
|
4430
|
+
# resp.name #=> String
|
4431
|
+
# resp.arn #=> String
|
4432
|
+
# resp.data_sources #=> Array
|
4433
|
+
# resp.data_sources[0].data_source_arn #=> String
|
4434
|
+
# resp.data_sources[0].data_source_description #=> String
|
4435
|
+
# resp.iam_identity_center_options.enabled #=> Boolean
|
4436
|
+
# resp.iam_identity_center_options.iam_identity_center_instance_arn #=> String
|
4437
|
+
# resp.iam_identity_center_options.iam_role_for_identity_center_application_arn #=> String
|
4438
|
+
# resp.iam_identity_center_options.iam_identity_center_application_arn #=> String
|
4439
|
+
# resp.app_configs #=> Array
|
4440
|
+
# resp.app_configs[0].key #=> String, one of "opensearchDashboards.dashboardAdmin.users", "opensearchDashboards.dashboardAdmin.groups"
|
4441
|
+
# resp.app_configs[0].value #=> String
|
4442
|
+
# resp.created_at #=> Time
|
4443
|
+
# resp.last_updated_at #=> Time
|
4444
|
+
#
|
4445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateApplication AWS API Documentation
|
4446
|
+
#
|
4447
|
+
# @overload update_application(params = {})
|
4448
|
+
# @param [Hash] params ({})
|
4449
|
+
def update_application(params = {}, options = {})
|
4450
|
+
req = build_request(:update_application, params)
|
4451
|
+
req.send_request(options)
|
4452
|
+
end
|
4453
|
+
|
4103
4454
|
# Updates a direct-query data source. For more information, see [Working
|
4104
4455
|
# with Amazon OpenSearch Service data source integrations with Amazon
|
4105
4456
|
# S3][1].
|
@@ -4238,6 +4589,9 @@ module Aws::OpenSearchService
|
|
4238
4589
|
# @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
|
4239
4590
|
# Options for fine-grained access control.
|
4240
4591
|
#
|
4592
|
+
# @option params [Types::IdentityCenterOptionsInput] :identity_center_options
|
4593
|
+
# Container for IAM Identity Center Options settings.
|
4594
|
+
#
|
4241
4595
|
# @option params [Types::AutoTuneOptions] :auto_tune_options
|
4242
4596
|
# Options for Auto-Tune.
|
4243
4597
|
#
|
@@ -4380,6 +4734,12 @@ module Aws::OpenSearchService
|
|
4380
4734
|
# },
|
4381
4735
|
# anonymous_auth_enabled: false,
|
4382
4736
|
# },
|
4737
|
+
# identity_center_options: {
|
4738
|
+
# enabled_api_access: false,
|
4739
|
+
# identity_center_instance_arn: "IdentityCenterInstanceARN",
|
4740
|
+
# subject_key: "UserName", # accepts UserName, UserId, Email
|
4741
|
+
# roles_key: "GroupName", # accepts GroupName, GroupId
|
4742
|
+
# },
|
4383
4743
|
# auto_tune_options: {
|
4384
4744
|
# desired_state: "ENABLED", # accepts ENABLED, DISABLED
|
4385
4745
|
# rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
|
@@ -4552,6 +4912,17 @@ module Aws::OpenSearchService
|
|
4552
4912
|
# resp.domain_config.advanced_security_options.status.update_version #=> Integer
|
4553
4913
|
# resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
4554
4914
|
# resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
|
4915
|
+
# resp.domain_config.identity_center_options.options.enabled_api_access #=> Boolean
|
4916
|
+
# resp.domain_config.identity_center_options.options.identity_center_instance_arn #=> String
|
4917
|
+
# resp.domain_config.identity_center_options.options.subject_key #=> String, one of "UserName", "UserId", "Email"
|
4918
|
+
# resp.domain_config.identity_center_options.options.roles_key #=> String, one of "GroupName", "GroupId"
|
4919
|
+
# resp.domain_config.identity_center_options.options.identity_center_application_arn #=> String
|
4920
|
+
# resp.domain_config.identity_center_options.options.identity_store_id #=> String
|
4921
|
+
# resp.domain_config.identity_center_options.status.creation_date #=> Time
|
4922
|
+
# resp.domain_config.identity_center_options.status.update_date #=> Time
|
4923
|
+
# resp.domain_config.identity_center_options.status.update_version #=> Integer
|
4924
|
+
# resp.domain_config.identity_center_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
4925
|
+
# resp.domain_config.identity_center_options.status.pending_deletion #=> Boolean
|
4555
4926
|
# resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
|
4556
4927
|
# resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
|
4557
4928
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
|
@@ -4896,7 +5267,7 @@ module Aws::OpenSearchService
|
|
4896
5267
|
tracer: tracer
|
4897
5268
|
)
|
4898
5269
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
4899
|
-
context[:gem_version] = '1.
|
5270
|
+
context[:gem_version] = '1.59.0'
|
4900
5271
|
Seahorse::Client::Request.new(handlers, context)
|
4901
5272
|
end
|
4902
5273
|
|