aws-sdk-opensearchservice 1.60.0 → 1.62.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +522 -25
- data/lib/aws-sdk-opensearchservice/client_api.rb +281 -0
- data/lib/aws-sdk-opensearchservice/types.rb +644 -14
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +159 -4
- data/sig/types.rbs +184 -4
- metadata +2 -2
@@ -190,12 +190,61 @@ module Aws::OpenSearchService
|
|
190
190
|
include Aws::Structure
|
191
191
|
end
|
192
192
|
|
193
|
+
# @!attribute [rw] data_source_name
|
194
|
+
# A unique, user-defined label to identify the data source within your
|
195
|
+
# OpenSearch Service environment.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] data_source_type
|
199
|
+
# The supported Amazon Web Services service that you want to use as
|
200
|
+
# the source for direct queries in OpenSearch Service.
|
201
|
+
# @return [Types::DirectQueryDataSourceType]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] description
|
204
|
+
# An optional text field for providing additional context and details
|
205
|
+
# about the data source.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] open_search_arns
|
209
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch
|
210
|
+
# collections that are associated with the direct query data source.
|
211
|
+
# @return [Array<String>]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] tag_list
|
214
|
+
# A list of tags attached to a domain.
|
215
|
+
# @return [Array<Types::Tag>]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDirectQueryDataSourceRequest AWS API Documentation
|
218
|
+
#
|
219
|
+
class AddDirectQueryDataSourceRequest < Struct.new(
|
220
|
+
:data_source_name,
|
221
|
+
:data_source_type,
|
222
|
+
:description,
|
223
|
+
:open_search_arns,
|
224
|
+
:tag_list)
|
225
|
+
SENSITIVE = []
|
226
|
+
include Aws::Structure
|
227
|
+
end
|
228
|
+
|
229
|
+
# @!attribute [rw] data_source_arn
|
230
|
+
# The unique, system-generated identifier that represents the data
|
231
|
+
# source.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDirectQueryDataSourceResponse AWS API Documentation
|
235
|
+
#
|
236
|
+
class AddDirectQueryDataSourceResponse < Struct.new(
|
237
|
+
:data_source_arn)
|
238
|
+
SENSITIVE = []
|
239
|
+
include Aws::Structure
|
240
|
+
end
|
241
|
+
|
193
242
|
# Container for the parameters to the `AddTags` operation. Specifies the
|
194
|
-
# tags to attach to the domain.
|
243
|
+
# tags to attach to the domain, data source, or application.
|
195
244
|
#
|
196
245
|
# @!attribute [rw] arn
|
197
|
-
# Amazon Resource Name (ARN) for the OpenSearch Service domain
|
198
|
-
# which you want to attach resource tags.
|
246
|
+
# Amazon Resource Name (ARN) for the OpenSearch Service domain, data
|
247
|
+
# source, or application to which you want to attach resource tags.
|
199
248
|
# @return [String]
|
200
249
|
#
|
201
250
|
# @!attribute [rw] tag_list
|
@@ -495,11 +544,23 @@ module Aws::OpenSearchService
|
|
495
544
|
# Name of the domain to associate the package with.
|
496
545
|
# @return [String]
|
497
546
|
#
|
547
|
+
# @!attribute [rw] prerequisite_package_id_list
|
548
|
+
# A list of package IDs that must be associated with the domain before
|
549
|
+
# the package specified in the request can be associated.
|
550
|
+
# @return [Array<String>]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] association_configuration
|
553
|
+
# The configuration for associating a package with an Amazon
|
554
|
+
# OpenSearch Service domain.
|
555
|
+
# @return [Types::PackageAssociationConfiguration]
|
556
|
+
#
|
498
557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackageRequest AWS API Documentation
|
499
558
|
#
|
500
559
|
class AssociatePackageRequest < Struct.new(
|
501
560
|
:package_id,
|
502
|
-
:domain_name
|
561
|
+
:domain_name,
|
562
|
+
:prerequisite_package_id_list,
|
563
|
+
:association_configuration)
|
503
564
|
SENSITIVE = []
|
504
565
|
include Aws::Structure
|
505
566
|
end
|
@@ -519,6 +580,39 @@ module Aws::OpenSearchService
|
|
519
580
|
include Aws::Structure
|
520
581
|
end
|
521
582
|
|
583
|
+
# @!attribute [rw] package_list
|
584
|
+
# A list of packages and their prerequisites to be associated with a
|
585
|
+
# domain.
|
586
|
+
# @return [Array<Types::PackageDetailsForAssociation>]
|
587
|
+
#
|
588
|
+
# @!attribute [rw] domain_name
|
589
|
+
# The name of an OpenSearch Service domain. Domain names are unique
|
590
|
+
# across the domains owned by an account within an Amazon Web Services
|
591
|
+
# Region.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackagesRequest AWS API Documentation
|
595
|
+
#
|
596
|
+
class AssociatePackagesRequest < Struct.new(
|
597
|
+
:package_list,
|
598
|
+
:domain_name)
|
599
|
+
SENSITIVE = []
|
600
|
+
include Aws::Structure
|
601
|
+
end
|
602
|
+
|
603
|
+
# @!attribute [rw] domain_package_details_list
|
604
|
+
# List of information about packages that are associated with a
|
605
|
+
# domain.
|
606
|
+
# @return [Array<Types::DomainPackageDetails>]
|
607
|
+
#
|
608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackagesResponse AWS API Documentation
|
609
|
+
#
|
610
|
+
class AssociatePackagesResponse < Struct.new(
|
611
|
+
:domain_package_details_list)
|
612
|
+
SENSITIVE = []
|
613
|
+
include Aws::Structure
|
614
|
+
end
|
615
|
+
|
522
616
|
# @!attribute [rw] domain_name
|
523
617
|
# The name of the OpenSearch Service domain to provide access to.
|
524
618
|
# @return [String]
|
@@ -1138,6 +1232,22 @@ module Aws::OpenSearchService
|
|
1138
1232
|
include Aws::Structure
|
1139
1233
|
end
|
1140
1234
|
|
1235
|
+
# Configuration details for a CloudWatch Logs data source that can be
|
1236
|
+
# used for direct queries.
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] role_arn
|
1239
|
+
# The unique identifier of the IAM role that grants OpenSearch Service
|
1240
|
+
# permission to access the specified data source.
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CloudWatchDirectQueryDataSource AWS API Documentation
|
1244
|
+
#
|
1245
|
+
class CloudWatchDirectQueryDataSource < Struct.new(
|
1246
|
+
:role_arn)
|
1247
|
+
SENSITIVE = []
|
1248
|
+
include Aws::Structure
|
1249
|
+
end
|
1250
|
+
|
1141
1251
|
# Container for the cluster configuration of an OpenSearch Service
|
1142
1252
|
# domain. For more information, see [Creating and managing Amazon
|
1143
1253
|
# OpenSearch Service domains][1].
|
@@ -1776,13 +1886,36 @@ module Aws::OpenSearchService
|
|
1776
1886
|
# The Amazon S3 location from which to import the package.
|
1777
1887
|
# @return [Types::PackageSource]
|
1778
1888
|
#
|
1889
|
+
# @!attribute [rw] package_configuration
|
1890
|
+
# The configuration parameters for the package being created.
|
1891
|
+
# @return [Types::PackageConfiguration]
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] engine_version
|
1894
|
+
# The version of the Amazon OpenSearch Service engine for which is
|
1895
|
+
# compatible with the package. This can only be specified for package
|
1896
|
+
# type `ZIP-PLUGIN`
|
1897
|
+
# @return [String]
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] package_vending_options
|
1900
|
+
# The vending options for the package being created. They determine if
|
1901
|
+
# the package can be vended to other users.
|
1902
|
+
# @return [Types::PackageVendingOptions]
|
1903
|
+
#
|
1904
|
+
# @!attribute [rw] package_encryption_options
|
1905
|
+
# The encryption parameters for the package being created.
|
1906
|
+
# @return [Types::PackageEncryptionOptions]
|
1907
|
+
#
|
1779
1908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackageRequest AWS API Documentation
|
1780
1909
|
#
|
1781
1910
|
class CreatePackageRequest < Struct.new(
|
1782
1911
|
:package_name,
|
1783
1912
|
:package_type,
|
1784
1913
|
:package_description,
|
1785
|
-
:package_source
|
1914
|
+
:package_source,
|
1915
|
+
:package_configuration,
|
1916
|
+
:engine_version,
|
1917
|
+
:package_vending_options,
|
1918
|
+
:package_encryption_options)
|
1786
1919
|
SENSITIVE = []
|
1787
1920
|
include Aws::Structure
|
1788
1921
|
end
|
@@ -1981,6 +2114,19 @@ module Aws::OpenSearchService
|
|
1981
2114
|
include Aws::Structure
|
1982
2115
|
end
|
1983
2116
|
|
2117
|
+
# @!attribute [rw] data_source_name
|
2118
|
+
# A unique, user-defined label to identify the data source within your
|
2119
|
+
# OpenSearch Service environment.
|
2120
|
+
# @return [String]
|
2121
|
+
#
|
2122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDirectQueryDataSourceRequest AWS API Documentation
|
2123
|
+
#
|
2124
|
+
class DeleteDirectQueryDataSourceRequest < Struct.new(
|
2125
|
+
:data_source_name)
|
2126
|
+
SENSITIVE = []
|
2127
|
+
include Aws::Structure
|
2128
|
+
end
|
2129
|
+
|
1984
2130
|
# Container for the parameters to the `DeleteDomain` operation.
|
1985
2131
|
#
|
1986
2132
|
# @!attribute [rw] domain_name
|
@@ -2864,6 +3010,83 @@ module Aws::OpenSearchService
|
|
2864
3010
|
include Aws::Structure
|
2865
3011
|
end
|
2866
3012
|
|
3013
|
+
# The configuration details for a data source that can be directly
|
3014
|
+
# queried.
|
3015
|
+
#
|
3016
|
+
# @!attribute [rw] data_source_name
|
3017
|
+
# A unique, user-defined label to identify the data source within your
|
3018
|
+
# OpenSearch Service environment.
|
3019
|
+
# @return [String]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] data_source_type
|
3022
|
+
# The supported Amazon Web Services service that is used as the source
|
3023
|
+
# for direct queries in OpenSearch Service.
|
3024
|
+
# @return [Types::DirectQueryDataSourceType]
|
3025
|
+
#
|
3026
|
+
# @!attribute [rw] description
|
3027
|
+
# A description that provides additional context and details about the
|
3028
|
+
# data source.
|
3029
|
+
# @return [String]
|
3030
|
+
#
|
3031
|
+
# @!attribute [rw] open_search_arns
|
3032
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch
|
3033
|
+
# collections that are associated with the direct query data source.
|
3034
|
+
# @return [Array<String>]
|
3035
|
+
#
|
3036
|
+
# @!attribute [rw] data_source_arn
|
3037
|
+
# The unique, system-generated identifier that represents the data
|
3038
|
+
# source.
|
3039
|
+
# @return [String]
|
3040
|
+
#
|
3041
|
+
# @!attribute [rw] tag_list
|
3042
|
+
# A list of tags attached to a direct query data source.
|
3043
|
+
# @return [Array<Types::Tag>]
|
3044
|
+
#
|
3045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DirectQueryDataSource AWS API Documentation
|
3046
|
+
#
|
3047
|
+
class DirectQueryDataSource < Struct.new(
|
3048
|
+
:data_source_name,
|
3049
|
+
:data_source_type,
|
3050
|
+
:description,
|
3051
|
+
:open_search_arns,
|
3052
|
+
:data_source_arn,
|
3053
|
+
:tag_list)
|
3054
|
+
SENSITIVE = []
|
3055
|
+
include Aws::Structure
|
3056
|
+
end
|
3057
|
+
|
3058
|
+
# The type of data source that is used for direct queries. This is a
|
3059
|
+
# supported Amazon Web Services service, such as CloudWatch Logs or
|
3060
|
+
# Security Lake.
|
3061
|
+
#
|
3062
|
+
# @note DirectQueryDataSourceType is a union - when making an API calls you must set exactly one of the members.
|
3063
|
+
#
|
3064
|
+
# @note DirectQueryDataSourceType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DirectQueryDataSourceType corresponding to the set member.
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] cloud_watch_log
|
3067
|
+
# Specifies CloudWatch Logs as a type of data source for direct
|
3068
|
+
# queries.
|
3069
|
+
# @return [Types::CloudWatchDirectQueryDataSource]
|
3070
|
+
#
|
3071
|
+
# @!attribute [rw] security_lake
|
3072
|
+
# Specifies Security Lake as a type of data source for direct queries.
|
3073
|
+
# @return [Types::SecurityLakeDirectQueryDataSource]
|
3074
|
+
#
|
3075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DirectQueryDataSourceType AWS API Documentation
|
3076
|
+
#
|
3077
|
+
class DirectQueryDataSourceType < Struct.new(
|
3078
|
+
:cloud_watch_log,
|
3079
|
+
:security_lake,
|
3080
|
+
:unknown)
|
3081
|
+
SENSITIVE = []
|
3082
|
+
include Aws::Structure
|
3083
|
+
include Aws::Structure::Union
|
3084
|
+
|
3085
|
+
class CloudWatchLog < DirectQueryDataSourceType; end
|
3086
|
+
class SecurityLake < DirectQueryDataSourceType; end
|
3087
|
+
class Unknown < DirectQueryDataSourceType; end
|
3088
|
+
end
|
3089
|
+
|
2867
3090
|
# An error occured because the client wanted to access an unsupported
|
2868
3091
|
# operation.
|
2869
3092
|
#
|
@@ -2908,6 +3131,38 @@ module Aws::OpenSearchService
|
|
2908
3131
|
include Aws::Structure
|
2909
3132
|
end
|
2910
3133
|
|
3134
|
+
# @!attribute [rw] package_list
|
3135
|
+
# A list of package IDs to be dissociated from a domain.
|
3136
|
+
# @return [Array<String>]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] domain_name
|
3139
|
+
# The name of an OpenSearch Service domain. Domain names are unique
|
3140
|
+
# across the domains owned by an account within an Amazon Web Services
|
3141
|
+
# Region.
|
3142
|
+
# @return [String]
|
3143
|
+
#
|
3144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackagesRequest AWS API Documentation
|
3145
|
+
#
|
3146
|
+
class DissociatePackagesRequest < Struct.new(
|
3147
|
+
:package_list,
|
3148
|
+
:domain_name)
|
3149
|
+
SENSITIVE = []
|
3150
|
+
include Aws::Structure
|
3151
|
+
end
|
3152
|
+
|
3153
|
+
# @!attribute [rw] domain_package_details_list
|
3154
|
+
# A list of package details for the packages that were dissociated
|
3155
|
+
# from the domain.
|
3156
|
+
# @return [Array<Types::DomainPackageDetails>]
|
3157
|
+
#
|
3158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackagesResponse AWS API Documentation
|
3159
|
+
#
|
3160
|
+
class DissociatePackagesResponse < Struct.new(
|
3161
|
+
:domain_package_details_list)
|
3162
|
+
SENSITIVE = []
|
3163
|
+
include Aws::Structure
|
3164
|
+
end
|
3165
|
+
|
2911
3166
|
# Container for the configuration of an OpenSearch Service domain.
|
2912
3167
|
#
|
2913
3168
|
# @!attribute [rw] engine_version
|
@@ -3272,6 +3527,11 @@ module Aws::OpenSearchService
|
|
3272
3527
|
# The current version of the package.
|
3273
3528
|
# @return [String]
|
3274
3529
|
#
|
3530
|
+
# @!attribute [rw] prerequisite_package_id_list
|
3531
|
+
# A list of package IDs that must be associated with the domain before
|
3532
|
+
# or with the package can be associated.
|
3533
|
+
# @return [Array<String>]
|
3534
|
+
#
|
3275
3535
|
# @!attribute [rw] reference_path
|
3276
3536
|
# The relative path of the package on the OpenSearch Service cluster
|
3277
3537
|
# nodes. This is `synonym_path` when the package is for synonym files.
|
@@ -3282,6 +3542,11 @@ module Aws::OpenSearchService
|
|
3282
3542
|
# otherwise.
|
3283
3543
|
# @return [Types::ErrorDetails]
|
3284
3544
|
#
|
3545
|
+
# @!attribute [rw] association_configuration
|
3546
|
+
# The configuration for associating a package with an Amazon
|
3547
|
+
# OpenSearch Service domain.
|
3548
|
+
# @return [Types::PackageAssociationConfiguration]
|
3549
|
+
#
|
3285
3550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainPackageDetails AWS API Documentation
|
3286
3551
|
#
|
3287
3552
|
class DomainPackageDetails < Struct.new(
|
@@ -3292,8 +3557,10 @@ module Aws::OpenSearchService
|
|
3292
3557
|
:domain_name,
|
3293
3558
|
:domain_package_status,
|
3294
3559
|
:package_version,
|
3560
|
+
:prerequisite_package_id_list,
|
3295
3561
|
:reference_path,
|
3296
|
-
:error_details
|
3562
|
+
:error_details,
|
3563
|
+
:association_configuration)
|
3297
3564
|
SENSITIVE = []
|
3298
3565
|
include Aws::Structure
|
3299
3566
|
end
|
@@ -3918,6 +4185,56 @@ module Aws::OpenSearchService
|
|
3918
4185
|
include Aws::Structure
|
3919
4186
|
end
|
3920
4187
|
|
4188
|
+
# @!attribute [rw] data_source_name
|
4189
|
+
# A unique, user-defined label that identifies the data source within
|
4190
|
+
# your OpenSearch Service environment.
|
4191
|
+
# @return [String]
|
4192
|
+
#
|
4193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDirectQueryDataSourceRequest AWS API Documentation
|
4194
|
+
#
|
4195
|
+
class GetDirectQueryDataSourceRequest < Struct.new(
|
4196
|
+
:data_source_name)
|
4197
|
+
SENSITIVE = []
|
4198
|
+
include Aws::Structure
|
4199
|
+
end
|
4200
|
+
|
4201
|
+
# @!attribute [rw] data_source_name
|
4202
|
+
# A unique, user-defined label to identify the data source within your
|
4203
|
+
# OpenSearch Service environment.
|
4204
|
+
# @return [String]
|
4205
|
+
#
|
4206
|
+
# @!attribute [rw] data_source_type
|
4207
|
+
# The supported Amazon Web Services service that is used as the source
|
4208
|
+
# for direct queries in OpenSearch Service.
|
4209
|
+
# @return [Types::DirectQueryDataSourceType]
|
4210
|
+
#
|
4211
|
+
# @!attribute [rw] description
|
4212
|
+
# A description that provides additional context and details about the
|
4213
|
+
# data source.
|
4214
|
+
# @return [String]
|
4215
|
+
#
|
4216
|
+
# @!attribute [rw] open_search_arns
|
4217
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch
|
4218
|
+
# collections that are associated with the direct query data source.
|
4219
|
+
# @return [Array<String>]
|
4220
|
+
#
|
4221
|
+
# @!attribute [rw] data_source_arn
|
4222
|
+
# The unique, system-generated identifier that represents the data
|
4223
|
+
# source.
|
4224
|
+
# @return [String]
|
4225
|
+
#
|
4226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDirectQueryDataSourceResponse AWS API Documentation
|
4227
|
+
#
|
4228
|
+
class GetDirectQueryDataSourceResponse < Struct.new(
|
4229
|
+
:data_source_name,
|
4230
|
+
:data_source_type,
|
4231
|
+
:description,
|
4232
|
+
:open_search_arns,
|
4233
|
+
:data_source_arn)
|
4234
|
+
SENSITIVE = []
|
4235
|
+
include Aws::Structure
|
4236
|
+
end
|
4237
|
+
|
3921
4238
|
# Container for the parameters to the `GetDomainMaintenanceStatus`
|
3922
4239
|
# operation.
|
3923
4240
|
#
|
@@ -4566,6 +4883,26 @@ module Aws::OpenSearchService
|
|
4566
4883
|
include Aws::Structure
|
4567
4884
|
end
|
4568
4885
|
|
4886
|
+
# The configuration parameters to enable access to the key store
|
4887
|
+
# required by the package.
|
4888
|
+
#
|
4889
|
+
# @!attribute [rw] key_access_role_arn
|
4890
|
+
# Role ARN to access the KeyStore Key
|
4891
|
+
# @return [String]
|
4892
|
+
#
|
4893
|
+
# @!attribute [rw] key_store_access_enabled
|
4894
|
+
# This indicates whether Key Store access is enabled
|
4895
|
+
# @return [Boolean]
|
4896
|
+
#
|
4897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/KeyStoreAccessOption AWS API Documentation
|
4898
|
+
#
|
4899
|
+
class KeyStoreAccessOption < Struct.new(
|
4900
|
+
:key_access_role_arn,
|
4901
|
+
:key_store_access_enabled)
|
4902
|
+
SENSITIVE = []
|
4903
|
+
include Aws::Structure
|
4904
|
+
end
|
4905
|
+
|
4569
4906
|
# An exception for trying to create more than the allowed number of
|
4570
4907
|
# resources or sub-resources.
|
4571
4908
|
#
|
@@ -4676,6 +5013,42 @@ module Aws::OpenSearchService
|
|
4676
5013
|
include Aws::Structure
|
4677
5014
|
end
|
4678
5015
|
|
5016
|
+
# @!attribute [rw] next_token
|
5017
|
+
# When `nextToken` is returned, there are more results available. The
|
5018
|
+
# value of `nextToken` is a unique pagination token for each page.
|
5019
|
+
# Send the request again using the returned token to retrieve the next
|
5020
|
+
# page.
|
5021
|
+
# @return [String]
|
5022
|
+
#
|
5023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDirectQueryDataSourcesRequest AWS API Documentation
|
5024
|
+
#
|
5025
|
+
class ListDirectQueryDataSourcesRequest < Struct.new(
|
5026
|
+
:next_token)
|
5027
|
+
SENSITIVE = []
|
5028
|
+
include Aws::Structure
|
5029
|
+
end
|
5030
|
+
|
5031
|
+
# @!attribute [rw] next_token
|
5032
|
+
# When `nextToken` is returned, there are more results available. The
|
5033
|
+
# value of `nextToken` is a unique pagination token for each page.
|
5034
|
+
# Send the request again using the returned token to retrieve the next
|
5035
|
+
# page.
|
5036
|
+
# @return [String]
|
5037
|
+
#
|
5038
|
+
# @!attribute [rw] direct_query_data_sources
|
5039
|
+
# A list of the direct query data sources that are returned by the
|
5040
|
+
# `ListDirectQueryDataSources` API operation.
|
5041
|
+
# @return [Array<Types::DirectQueryDataSource>]
|
5042
|
+
#
|
5043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDirectQueryDataSourcesResponse AWS API Documentation
|
5044
|
+
#
|
5045
|
+
class ListDirectQueryDataSourcesResponse < Struct.new(
|
5046
|
+
:next_token,
|
5047
|
+
:direct_query_data_sources)
|
5048
|
+
SENSITIVE = []
|
5049
|
+
include Aws::Structure
|
5050
|
+
end
|
5051
|
+
|
4679
5052
|
# Container for the parameters to the `ListDomainMaintenances`
|
4680
5053
|
# operation.
|
4681
5054
|
#
|
@@ -4989,7 +5362,8 @@ module Aws::OpenSearchService
|
|
4989
5362
|
# Container for the parameters to the `ListTags` operation.
|
4990
5363
|
#
|
4991
5364
|
# @!attribute [rw] arn
|
4992
|
-
# Amazon Resource Name (ARN) for the domain
|
5365
|
+
# Amazon Resource Name (ARN) for the domain, data source, or
|
5366
|
+
# application to view tags for.
|
4993
5367
|
# @return [String]
|
4994
5368
|
#
|
4995
5369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTagsRequest AWS API Documentation
|
@@ -5003,7 +5377,8 @@ module Aws::OpenSearchService
|
|
5003
5377
|
# The results of a `ListTags` operation.
|
5004
5378
|
#
|
5005
5379
|
# @!attribute [rw] tag_list
|
5006
|
-
# List of resource tags associated with the specified domain
|
5380
|
+
# List of resource tags associated with the specified domain, data
|
5381
|
+
# source, or application.
|
5007
5382
|
# @return [Array<Types::Tag>]
|
5008
5383
|
#
|
5009
5384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTagsResponse AWS API Documentation
|
@@ -5629,6 +6004,51 @@ module Aws::OpenSearchService
|
|
5629
6004
|
include Aws::Structure
|
5630
6005
|
end
|
5631
6006
|
|
6007
|
+
# The configuration for associating a package with a domain.
|
6008
|
+
#
|
6009
|
+
# @!attribute [rw] key_store_access_option
|
6010
|
+
# The configuration parameters to enable accessing the key store
|
6011
|
+
# required by the package.
|
6012
|
+
# @return [Types::KeyStoreAccessOption]
|
6013
|
+
#
|
6014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageAssociationConfiguration AWS API Documentation
|
6015
|
+
#
|
6016
|
+
class PackageAssociationConfiguration < Struct.new(
|
6017
|
+
:key_store_access_option)
|
6018
|
+
SENSITIVE = []
|
6019
|
+
include Aws::Structure
|
6020
|
+
end
|
6021
|
+
|
6022
|
+
# The configuration parameters for a package.
|
6023
|
+
#
|
6024
|
+
# @!attribute [rw] license_requirement
|
6025
|
+
# The license requirements for the package.
|
6026
|
+
# @return [String]
|
6027
|
+
#
|
6028
|
+
# @!attribute [rw] license_filepath
|
6029
|
+
# The relative file path for the license associated with the package.
|
6030
|
+
# @return [String]
|
6031
|
+
#
|
6032
|
+
# @!attribute [rw] configuration_requirement
|
6033
|
+
# The configuration requirements for the package.
|
6034
|
+
# @return [String]
|
6035
|
+
#
|
6036
|
+
# @!attribute [rw] requires_restart_for_configuration_update
|
6037
|
+
# This indicates whether a B/G deployment is required for updating the
|
6038
|
+
# configuration that the plugin is prerequisite for.
|
6039
|
+
# @return [Boolean]
|
6040
|
+
#
|
6041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageConfiguration AWS API Documentation
|
6042
|
+
#
|
6043
|
+
class PackageConfiguration < Struct.new(
|
6044
|
+
:license_requirement,
|
6045
|
+
:license_filepath,
|
6046
|
+
:configuration_requirement,
|
6047
|
+
:requires_restart_for_configuration_update)
|
6048
|
+
SENSITIVE = []
|
6049
|
+
include Aws::Structure
|
6050
|
+
end
|
6051
|
+
|
5632
6052
|
# Basic information about a package.
|
5633
6053
|
#
|
5634
6054
|
# @!attribute [rw] package_id
|
@@ -5681,6 +6101,29 @@ module Aws::OpenSearchService
|
|
5681
6101
|
# about plugin properties.
|
5682
6102
|
# @return [Types::PluginProperties]
|
5683
6103
|
#
|
6104
|
+
# @!attribute [rw] available_package_configuration
|
6105
|
+
# This represents the available configuration parameters for the
|
6106
|
+
# package.
|
6107
|
+
# @return [Types::PackageConfiguration]
|
6108
|
+
#
|
6109
|
+
# @!attribute [rw] allow_listed_user_list
|
6110
|
+
# A list of users who are allowed to view and associate the package.
|
6111
|
+
# This field is only visible to the owner of a package.
|
6112
|
+
# @return [Array<String>]
|
6113
|
+
#
|
6114
|
+
# @!attribute [rw] package_owner
|
6115
|
+
# The owner of the package who is allowed to create/update a package
|
6116
|
+
# and add users to the package scope.
|
6117
|
+
# @return [String]
|
6118
|
+
#
|
6119
|
+
# @!attribute [rw] package_vending_options
|
6120
|
+
# Package Vending Options for a package.
|
6121
|
+
# @return [Types::PackageVendingOptions]
|
6122
|
+
#
|
6123
|
+
# @!attribute [rw] package_encryption_options
|
6124
|
+
# Package Encryption Options for a package.
|
6125
|
+
# @return [Types::PackageEncryptionOptions]
|
6126
|
+
#
|
5684
6127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageDetails AWS API Documentation
|
5685
6128
|
#
|
5686
6129
|
class PackageDetails < Struct.new(
|
@@ -5694,7 +6137,57 @@ module Aws::OpenSearchService
|
|
5694
6137
|
:available_package_version,
|
5695
6138
|
:error_details,
|
5696
6139
|
:engine_version,
|
5697
|
-
:available_plugin_properties
|
6140
|
+
:available_plugin_properties,
|
6141
|
+
:available_package_configuration,
|
6142
|
+
:allow_listed_user_list,
|
6143
|
+
:package_owner,
|
6144
|
+
:package_vending_options,
|
6145
|
+
:package_encryption_options)
|
6146
|
+
SENSITIVE = []
|
6147
|
+
include Aws::Structure
|
6148
|
+
end
|
6149
|
+
|
6150
|
+
# Details of a package that is associated with a domain.
|
6151
|
+
#
|
6152
|
+
# @!attribute [rw] package_id
|
6153
|
+
# Internal ID of the package that you want to associate with a domain.
|
6154
|
+
# @return [String]
|
6155
|
+
#
|
6156
|
+
# @!attribute [rw] prerequisite_package_id_list
|
6157
|
+
# List of package IDs that must be associated with the domain with or
|
6158
|
+
# before the package can be associated.
|
6159
|
+
# @return [Array<String>]
|
6160
|
+
#
|
6161
|
+
# @!attribute [rw] association_configuration
|
6162
|
+
# The configuration parameters for associating the package with a
|
6163
|
+
# domain.
|
6164
|
+
# @return [Types::PackageAssociationConfiguration]
|
6165
|
+
#
|
6166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageDetailsForAssociation AWS API Documentation
|
6167
|
+
#
|
6168
|
+
class PackageDetailsForAssociation < Struct.new(
|
6169
|
+
:package_id,
|
6170
|
+
:prerequisite_package_id_list,
|
6171
|
+
:association_configuration)
|
6172
|
+
SENSITIVE = []
|
6173
|
+
include Aws::Structure
|
6174
|
+
end
|
6175
|
+
|
6176
|
+
# Encryption options for a package.
|
6177
|
+
#
|
6178
|
+
# @!attribute [rw] kms_key_identifier
|
6179
|
+
# KMS key ID for encrypting the package.
|
6180
|
+
# @return [String]
|
6181
|
+
#
|
6182
|
+
# @!attribute [rw] encryption_enabled
|
6183
|
+
# This indicates whether encryption is enabled for the package.
|
6184
|
+
# @return [Boolean]
|
6185
|
+
#
|
6186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageEncryptionOptions AWS API Documentation
|
6187
|
+
#
|
6188
|
+
class PackageEncryptionOptions < Struct.new(
|
6189
|
+
:kms_key_identifier,
|
6190
|
+
:encryption_enabled)
|
5698
6191
|
SENSITIVE = []
|
5699
6192
|
include Aws::Structure
|
5700
6193
|
end
|
@@ -5718,6 +6211,22 @@ module Aws::OpenSearchService
|
|
5718
6211
|
include Aws::Structure
|
5719
6212
|
end
|
5720
6213
|
|
6214
|
+
# The vending options for a package to determine if the package can be
|
6215
|
+
# used by other users.
|
6216
|
+
#
|
6217
|
+
# @!attribute [rw] vending_enabled
|
6218
|
+
# This indicates whether vending is enabled for the package to
|
6219
|
+
# determine if package can be used by other users.
|
6220
|
+
# @return [Boolean]
|
6221
|
+
#
|
6222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageVendingOptions AWS API Documentation
|
6223
|
+
#
|
6224
|
+
class PackageVendingOptions < Struct.new(
|
6225
|
+
:vending_enabled)
|
6226
|
+
SENSITIVE = []
|
6227
|
+
include Aws::Structure
|
6228
|
+
end
|
6229
|
+
|
5721
6230
|
# Details about a package version.
|
5722
6231
|
#
|
5723
6232
|
# @!attribute [rw] package_version
|
@@ -5737,13 +6246,18 @@ module Aws::OpenSearchService
|
|
5737
6246
|
# `ZIP-PLUGIN` package.
|
5738
6247
|
# @return [Types::PluginProperties]
|
5739
6248
|
#
|
6249
|
+
# @!attribute [rw] package_configuration
|
6250
|
+
# The configuration details for a specific version of a package.
|
6251
|
+
# @return [Types::PackageConfiguration]
|
6252
|
+
#
|
5740
6253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageVersionHistory AWS API Documentation
|
5741
6254
|
#
|
5742
6255
|
class PackageVersionHistory < Struct.new(
|
5743
6256
|
:package_version,
|
5744
6257
|
:commit_message,
|
5745
6258
|
:created_at,
|
5746
|
-
:plugin_properties
|
6259
|
+
:plugin_properties,
|
6260
|
+
:package_configuration)
|
5747
6261
|
SENSITIVE = []
|
5748
6262
|
include Aws::Structure
|
5749
6263
|
end
|
@@ -5879,12 +6393,13 @@ module Aws::OpenSearchService
|
|
5879
6393
|
# Container for the request parameters to the `RemoveTags` operation.
|
5880
6394
|
#
|
5881
6395
|
# @!attribute [rw] arn
|
5882
|
-
# The Amazon Resource Name (ARN) of the domain
|
5883
|
-
# delete the specified tags.
|
6396
|
+
# The Amazon Resource Name (ARN) of the domain, data source, or
|
6397
|
+
# application from which you want to delete the specified tags.
|
5884
6398
|
# @return [String]
|
5885
6399
|
#
|
5886
6400
|
# @!attribute [rw] tag_keys
|
5887
|
-
# The list of tag keys to remove from the domain
|
6401
|
+
# The list of tag keys to remove from the domain, data source, or
|
6402
|
+
# application.
|
5888
6403
|
# @return [Array<String>]
|
5889
6404
|
#
|
5890
6405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveTagsRequest AWS API Documentation
|
@@ -6289,6 +6804,22 @@ module Aws::OpenSearchService
|
|
6289
6804
|
include Aws::Structure
|
6290
6805
|
end
|
6291
6806
|
|
6807
|
+
# Configuration details for a Security Lake data source that can be used
|
6808
|
+
# for direct queries.
|
6809
|
+
#
|
6810
|
+
# @!attribute [rw] role_arn
|
6811
|
+
# The unique identifier of the IAM role that grants OpenSearch Service
|
6812
|
+
# permission to access the specified data source.
|
6813
|
+
# @return [String]
|
6814
|
+
#
|
6815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SecurityLakeDirectQueryDataSource AWS API Documentation
|
6816
|
+
#
|
6817
|
+
class SecurityLakeDirectQueryDataSource < Struct.new(
|
6818
|
+
:role_arn)
|
6819
|
+
SENSITIVE = []
|
6820
|
+
include Aws::Structure
|
6821
|
+
end
|
6822
|
+
|
6292
6823
|
# The current status of the service software for an Amazon OpenSearch
|
6293
6824
|
# Service domain. For more information, see [Service software updates in
|
6294
6825
|
# Amazon OpenSearch Service][1].
|
@@ -6748,6 +7279,50 @@ module Aws::OpenSearchService
|
|
6748
7279
|
include Aws::Structure
|
6749
7280
|
end
|
6750
7281
|
|
7282
|
+
# @!attribute [rw] data_source_name
|
7283
|
+
# A unique, user-defined label to identify the data source within your
|
7284
|
+
# OpenSearch Service environment.
|
7285
|
+
# @return [String]
|
7286
|
+
#
|
7287
|
+
# @!attribute [rw] data_source_type
|
7288
|
+
# The supported Amazon Web Services service that you want to use as
|
7289
|
+
# the source for direct queries in OpenSearch Service.
|
7290
|
+
# @return [Types::DirectQueryDataSourceType]
|
7291
|
+
#
|
7292
|
+
# @!attribute [rw] description
|
7293
|
+
# An optional text field for providing additional context and details
|
7294
|
+
# about the data source.
|
7295
|
+
# @return [String]
|
7296
|
+
#
|
7297
|
+
# @!attribute [rw] open_search_arns
|
7298
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch
|
7299
|
+
# collections that are associated with the direct query data source.
|
7300
|
+
# @return [Array<String>]
|
7301
|
+
#
|
7302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDirectQueryDataSourceRequest AWS API Documentation
|
7303
|
+
#
|
7304
|
+
class UpdateDirectQueryDataSourceRequest < Struct.new(
|
7305
|
+
:data_source_name,
|
7306
|
+
:data_source_type,
|
7307
|
+
:description,
|
7308
|
+
:open_search_arns)
|
7309
|
+
SENSITIVE = []
|
7310
|
+
include Aws::Structure
|
7311
|
+
end
|
7312
|
+
|
7313
|
+
# @!attribute [rw] data_source_arn
|
7314
|
+
# The unique, system-generated identifier that represents the data
|
7315
|
+
# source.
|
7316
|
+
# @return [String]
|
7317
|
+
#
|
7318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDirectQueryDataSourceResponse AWS API Documentation
|
7319
|
+
#
|
7320
|
+
class UpdateDirectQueryDataSourceResponse < Struct.new(
|
7321
|
+
:data_source_arn)
|
7322
|
+
SENSITIVE = []
|
7323
|
+
include Aws::Structure
|
7324
|
+
end
|
7325
|
+
|
6751
7326
|
# Container for the request parameters to the `UpdateDomain` operation.
|
6752
7327
|
#
|
6753
7328
|
# @!attribute [rw] domain_name
|
@@ -6958,13 +7533,23 @@ module Aws::OpenSearchService
|
|
6958
7533
|
# `GetPackageVersionHistoryResponse`.
|
6959
7534
|
# @return [String]
|
6960
7535
|
#
|
7536
|
+
# @!attribute [rw] package_configuration
|
7537
|
+
# The updated configuration details for a package.
|
7538
|
+
# @return [Types::PackageConfiguration]
|
7539
|
+
#
|
7540
|
+
# @!attribute [rw] package_encryption_options
|
7541
|
+
# Encryption options for a package.
|
7542
|
+
# @return [Types::PackageEncryptionOptions]
|
7543
|
+
#
|
6961
7544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageRequest AWS API Documentation
|
6962
7545
|
#
|
6963
7546
|
class UpdatePackageRequest < Struct.new(
|
6964
7547
|
:package_id,
|
6965
7548
|
:package_source,
|
6966
7549
|
:package_description,
|
6967
|
-
:commit_message
|
7550
|
+
:commit_message,
|
7551
|
+
:package_configuration,
|
7552
|
+
:package_encryption_options)
|
6968
7553
|
SENSITIVE = []
|
6969
7554
|
include Aws::Structure
|
6970
7555
|
end
|
@@ -6983,6 +7568,51 @@ module Aws::OpenSearchService
|
|
6983
7568
|
include Aws::Structure
|
6984
7569
|
end
|
6985
7570
|
|
7571
|
+
# @!attribute [rw] package_id
|
7572
|
+
# ID of the package whose scope is being updated.
|
7573
|
+
# @return [String]
|
7574
|
+
#
|
7575
|
+
# @!attribute [rw] operation
|
7576
|
+
# The operation to perform on the package scope (e.g.,
|
7577
|
+
# add/remove/override users).
|
7578
|
+
# @return [String]
|
7579
|
+
#
|
7580
|
+
# @!attribute [rw] package_user_list
|
7581
|
+
# List of users to be added or removed from the package scope.
|
7582
|
+
# @return [Array<String>]
|
7583
|
+
#
|
7584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageScopeRequest AWS API Documentation
|
7585
|
+
#
|
7586
|
+
class UpdatePackageScopeRequest < Struct.new(
|
7587
|
+
:package_id,
|
7588
|
+
:operation,
|
7589
|
+
:package_user_list)
|
7590
|
+
SENSITIVE = []
|
7591
|
+
include Aws::Structure
|
7592
|
+
end
|
7593
|
+
|
7594
|
+
# @!attribute [rw] package_id
|
7595
|
+
# ID of the package whose scope was updated.
|
7596
|
+
# @return [String]
|
7597
|
+
#
|
7598
|
+
# @!attribute [rw] operation
|
7599
|
+
# The operation that was performed on the package scope.
|
7600
|
+
# @return [String]
|
7601
|
+
#
|
7602
|
+
# @!attribute [rw] package_user_list
|
7603
|
+
# List of users who have access to the package after the scope update.
|
7604
|
+
# @return [Array<String>]
|
7605
|
+
#
|
7606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageScopeResponse AWS API Documentation
|
7607
|
+
#
|
7608
|
+
class UpdatePackageScopeResponse < Struct.new(
|
7609
|
+
:package_id,
|
7610
|
+
:operation,
|
7611
|
+
:package_user_list)
|
7612
|
+
SENSITIVE = []
|
7613
|
+
include Aws::Structure
|
7614
|
+
end
|
7615
|
+
|
6986
7616
|
# @!attribute [rw] domain_name
|
6987
7617
|
# The name of the domain to reschedule an action for.
|
6988
7618
|
# @return [String]
|