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
@@ -541,18 +541,81 @@ module Aws::OpenSearchService
|
|
541
541
|
req.send_request(options)
|
542
542
|
end
|
543
543
|
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
544
|
+
# Adds a new data source in Amazon OpenSearch Service so that you can
|
545
|
+
# perform direct queries on external data.
|
546
|
+
#
|
547
|
+
# @option params [required, String] :data_source_name
|
548
|
+
# A unique, user-defined label to identify the data source within your
|
549
|
+
# OpenSearch Service environment.
|
550
|
+
#
|
551
|
+
# @option params [required, Types::DirectQueryDataSourceType] :data_source_type
|
552
|
+
# The supported Amazon Web Services service that you want to use as the
|
553
|
+
# source for direct queries in OpenSearch Service.
|
554
|
+
#
|
555
|
+
# @option params [String] :description
|
556
|
+
# An optional text field for providing additional context and details
|
557
|
+
# about the data source.
|
558
|
+
#
|
559
|
+
# @option params [required, Array<String>] :open_search_arns
|
560
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch collections
|
561
|
+
# that are associated with the direct query data source.
|
562
|
+
#
|
563
|
+
# @option params [Array<Types::Tag>] :tag_list
|
564
|
+
# A list of tags attached to a domain.
|
565
|
+
#
|
566
|
+
# @return [Types::AddDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
567
|
+
#
|
568
|
+
# * {Types::AddDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
569
|
+
#
|
570
|
+
# @example Request syntax with placeholder values
|
571
|
+
#
|
572
|
+
# resp = client.add_direct_query_data_source({
|
573
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
574
|
+
# data_source_type: { # required
|
575
|
+
# cloud_watch_log: {
|
576
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
577
|
+
# },
|
578
|
+
# security_lake: {
|
579
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
580
|
+
# },
|
581
|
+
# },
|
582
|
+
# description: "DirectQueryDataSourceDescription",
|
583
|
+
# open_search_arns: ["ARN"], # required
|
584
|
+
# tag_list: [
|
585
|
+
# {
|
586
|
+
# key: "TagKey", # required
|
587
|
+
# value: "TagValue", # required
|
588
|
+
# },
|
589
|
+
# ],
|
590
|
+
# })
|
591
|
+
#
|
592
|
+
# @example Response structure
|
593
|
+
#
|
594
|
+
# resp.data_source_arn #=> String
|
595
|
+
#
|
596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDirectQueryDataSource AWS API Documentation
|
597
|
+
#
|
598
|
+
# @overload add_direct_query_data_source(params = {})
|
599
|
+
# @param [Hash] params ({})
|
600
|
+
def add_direct_query_data_source(params = {}, options = {})
|
601
|
+
req = build_request(:add_direct_query_data_source, params)
|
602
|
+
req.send_request(options)
|
603
|
+
end
|
604
|
+
|
605
|
+
# Attaches tags to an existing Amazon OpenSearch Service domain, data
|
606
|
+
# source, or application.
|
607
|
+
#
|
608
|
+
# Tags are a set of case-sensitive key-value pairs. A domain, data
|
609
|
+
# source, or application can have up to 10 tags. For more information,
|
610
|
+
# see [Tagging Amazon OpenSearch Service resources][1].
|
548
611
|
#
|
549
612
|
#
|
550
613
|
#
|
551
614
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html
|
552
615
|
#
|
553
616
|
# @option params [required, String] :arn
|
554
|
-
# Amazon Resource Name (ARN) for the OpenSearch Service domain
|
555
|
-
# you want to attach resource tags.
|
617
|
+
# Amazon Resource Name (ARN) for the OpenSearch Service domain, data
|
618
|
+
# source, or application to which you want to attach resource tags.
|
556
619
|
#
|
557
620
|
# @option params [required, Array<Types::Tag>] :tag_list
|
558
621
|
# List of resource tags.
|
@@ -595,6 +658,14 @@ module Aws::OpenSearchService
|
|
595
658
|
# @option params [required, String] :domain_name
|
596
659
|
# Name of the domain to associate the package with.
|
597
660
|
#
|
661
|
+
# @option params [Array<String>] :prerequisite_package_id_list
|
662
|
+
# A list of package IDs that must be associated with the domain before
|
663
|
+
# the package specified in the request can be associated.
|
664
|
+
#
|
665
|
+
# @option params [Types::PackageAssociationConfiguration] :association_configuration
|
666
|
+
# The configuration for associating a package with an Amazon OpenSearch
|
667
|
+
# Service domain.
|
668
|
+
#
|
598
669
|
# @return [Types::AssociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
599
670
|
#
|
600
671
|
# * {Types::AssociatePackageResponse#domain_package_details #domain_package_details} => Types::DomainPackageDetails
|
@@ -604,20 +675,31 @@ module Aws::OpenSearchService
|
|
604
675
|
# resp = client.associate_package({
|
605
676
|
# package_id: "PackageID", # required
|
606
677
|
# domain_name: "DomainName", # required
|
678
|
+
# prerequisite_package_id_list: ["PackageID"],
|
679
|
+
# association_configuration: {
|
680
|
+
# key_store_access_option: {
|
681
|
+
# key_access_role_arn: "RoleArn",
|
682
|
+
# key_store_access_enabled: false, # required
|
683
|
+
# },
|
684
|
+
# },
|
607
685
|
# })
|
608
686
|
#
|
609
687
|
# @example Response structure
|
610
688
|
#
|
611
689
|
# resp.domain_package_details.package_id #=> String
|
612
690
|
# resp.domain_package_details.package_name #=> String
|
613
|
-
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
691
|
+
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
614
692
|
# resp.domain_package_details.last_updated #=> Time
|
615
693
|
# resp.domain_package_details.domain_name #=> String
|
616
694
|
# resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
617
695
|
# resp.domain_package_details.package_version #=> String
|
696
|
+
# resp.domain_package_details.prerequisite_package_id_list #=> Array
|
697
|
+
# resp.domain_package_details.prerequisite_package_id_list[0] #=> String
|
618
698
|
# resp.domain_package_details.reference_path #=> String
|
619
699
|
# resp.domain_package_details.error_details.error_type #=> String
|
620
700
|
# resp.domain_package_details.error_details.error_message #=> String
|
701
|
+
# resp.domain_package_details.association_configuration.key_store_access_option.key_access_role_arn #=> String
|
702
|
+
# resp.domain_package_details.association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
621
703
|
#
|
622
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage AWS API Documentation
|
623
705
|
#
|
@@ -628,6 +710,67 @@ module Aws::OpenSearchService
|
|
628
710
|
req.send_request(options)
|
629
711
|
end
|
630
712
|
|
713
|
+
# Operation in the Amazon OpenSearch Service API for associating
|
714
|
+
# multiple packages with a domain simultaneously.
|
715
|
+
#
|
716
|
+
# @option params [required, Array<Types::PackageDetailsForAssociation>] :package_list
|
717
|
+
# A list of packages and their prerequisites to be associated with a
|
718
|
+
# domain.
|
719
|
+
#
|
720
|
+
# @option params [required, String] :domain_name
|
721
|
+
# The name of an OpenSearch Service domain. Domain names are unique
|
722
|
+
# across the domains owned by an account within an Amazon Web Services
|
723
|
+
# Region.
|
724
|
+
#
|
725
|
+
# @return [Types::AssociatePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
726
|
+
#
|
727
|
+
# * {Types::AssociatePackagesResponse#domain_package_details_list #domain_package_details_list} => Array<Types::DomainPackageDetails>
|
728
|
+
#
|
729
|
+
# @example Request syntax with placeholder values
|
730
|
+
#
|
731
|
+
# resp = client.associate_packages({
|
732
|
+
# package_list: [ # required
|
733
|
+
# {
|
734
|
+
# package_id: "PackageID", # required
|
735
|
+
# prerequisite_package_id_list: ["PackageID"],
|
736
|
+
# association_configuration: {
|
737
|
+
# key_store_access_option: {
|
738
|
+
# key_access_role_arn: "RoleArn",
|
739
|
+
# key_store_access_enabled: false, # required
|
740
|
+
# },
|
741
|
+
# },
|
742
|
+
# },
|
743
|
+
# ],
|
744
|
+
# domain_name: "DomainName", # required
|
745
|
+
# })
|
746
|
+
#
|
747
|
+
# @example Response structure
|
748
|
+
#
|
749
|
+
# resp.domain_package_details_list #=> Array
|
750
|
+
# resp.domain_package_details_list[0].package_id #=> String
|
751
|
+
# resp.domain_package_details_list[0].package_name #=> String
|
752
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
753
|
+
# resp.domain_package_details_list[0].last_updated #=> Time
|
754
|
+
# resp.domain_package_details_list[0].domain_name #=> String
|
755
|
+
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
756
|
+
# resp.domain_package_details_list[0].package_version #=> String
|
757
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list #=> Array
|
758
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list[0] #=> String
|
759
|
+
# resp.domain_package_details_list[0].reference_path #=> String
|
760
|
+
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
761
|
+
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
762
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_access_role_arn #=> String
|
763
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
764
|
+
#
|
765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackages AWS API Documentation
|
766
|
+
#
|
767
|
+
# @overload associate_packages(params = {})
|
768
|
+
# @param [Hash] params ({})
|
769
|
+
def associate_packages(params = {}, options = {})
|
770
|
+
req = build_request(:associate_packages, params)
|
771
|
+
req.send_request(options)
|
772
|
+
end
|
773
|
+
|
631
774
|
# Provides access to an Amazon OpenSearch Service domain through the use
|
632
775
|
# of an interface VPC endpoint.
|
633
776
|
#
|
@@ -1369,6 +1512,21 @@ module Aws::OpenSearchService
|
|
1369
1512
|
# @option params [required, Types::PackageSource] :package_source
|
1370
1513
|
# The Amazon S3 location from which to import the package.
|
1371
1514
|
#
|
1515
|
+
# @option params [Types::PackageConfiguration] :package_configuration
|
1516
|
+
# The configuration parameters for the package being created.
|
1517
|
+
#
|
1518
|
+
# @option params [String] :engine_version
|
1519
|
+
# The version of the Amazon OpenSearch Service engine for which is
|
1520
|
+
# compatible with the package. This can only be specified for package
|
1521
|
+
# type `ZIP-PLUGIN`
|
1522
|
+
#
|
1523
|
+
# @option params [Types::PackageVendingOptions] :package_vending_options
|
1524
|
+
# The vending options for the package being created. They determine if
|
1525
|
+
# the package can be vended to other users.
|
1526
|
+
#
|
1527
|
+
# @option params [Types::PackageEncryptionOptions] :package_encryption_options
|
1528
|
+
# The encryption parameters for the package being created.
|
1529
|
+
#
|
1372
1530
|
# @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1373
1531
|
#
|
1374
1532
|
# * {Types::CreatePackageResponse#package_details #package_details} => Types::PackageDetails
|
@@ -1377,19 +1535,33 @@ module Aws::OpenSearchService
|
|
1377
1535
|
#
|
1378
1536
|
# resp = client.create_package({
|
1379
1537
|
# package_name: "PackageName", # required
|
1380
|
-
# package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY, ZIP-PLUGIN
|
1538
|
+
# package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY, ZIP-PLUGIN, PACKAGE-LICENSE, PACKAGE-CONFIG
|
1381
1539
|
# package_description: "PackageDescription",
|
1382
1540
|
# package_source: { # required
|
1383
1541
|
# s3_bucket_name: "S3BucketName",
|
1384
1542
|
# s3_key: "S3Key",
|
1385
1543
|
# },
|
1544
|
+
# package_configuration: {
|
1545
|
+
# license_requirement: "REQUIRED", # required, accepts REQUIRED, OPTIONAL, NONE
|
1546
|
+
# license_filepath: "LicenseFilepath",
|
1547
|
+
# configuration_requirement: "REQUIRED", # required, accepts REQUIRED, OPTIONAL, NONE
|
1548
|
+
# requires_restart_for_configuration_update: false,
|
1549
|
+
# },
|
1550
|
+
# engine_version: "EngineVersion",
|
1551
|
+
# package_vending_options: {
|
1552
|
+
# vending_enabled: false, # required
|
1553
|
+
# },
|
1554
|
+
# package_encryption_options: {
|
1555
|
+
# kms_key_identifier: "KmsKeyId",
|
1556
|
+
# encryption_enabled: false, # required
|
1557
|
+
# },
|
1386
1558
|
# })
|
1387
1559
|
#
|
1388
1560
|
# @example Response structure
|
1389
1561
|
#
|
1390
1562
|
# resp.package_details.package_id #=> String
|
1391
1563
|
# resp.package_details.package_name #=> String
|
1392
|
-
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
1564
|
+
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
1393
1565
|
# resp.package_details.package_description #=> String
|
1394
1566
|
# resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
1395
1567
|
# resp.package_details.created_at #=> Time
|
@@ -1403,6 +1575,16 @@ module Aws::OpenSearchService
|
|
1403
1575
|
# resp.package_details.available_plugin_properties.version #=> String
|
1404
1576
|
# resp.package_details.available_plugin_properties.class_name #=> String
|
1405
1577
|
# resp.package_details.available_plugin_properties.uncompressed_size_in_bytes #=> Integer
|
1578
|
+
# resp.package_details.available_package_configuration.license_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
1579
|
+
# resp.package_details.available_package_configuration.license_filepath #=> String
|
1580
|
+
# resp.package_details.available_package_configuration.configuration_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
1581
|
+
# resp.package_details.available_package_configuration.requires_restart_for_configuration_update #=> Boolean
|
1582
|
+
# resp.package_details.allow_listed_user_list #=> Array
|
1583
|
+
# resp.package_details.allow_listed_user_list[0] #=> String
|
1584
|
+
# resp.package_details.package_owner #=> String
|
1585
|
+
# resp.package_details.package_vending_options.vending_enabled #=> Boolean
|
1586
|
+
# resp.package_details.package_encryption_options.kms_key_identifier #=> String
|
1587
|
+
# resp.package_details.package_encryption_options.encryption_enabled #=> Boolean
|
1406
1588
|
#
|
1407
1589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage AWS API Documentation
|
1408
1590
|
#
|
@@ -1525,6 +1707,30 @@ module Aws::OpenSearchService
|
|
1525
1707
|
req.send_request(options)
|
1526
1708
|
end
|
1527
1709
|
|
1710
|
+
# Deletes a previously configured direct query data source from Amazon
|
1711
|
+
# OpenSearch Service.
|
1712
|
+
#
|
1713
|
+
# @option params [required, String] :data_source_name
|
1714
|
+
# A unique, user-defined label to identify the data source within your
|
1715
|
+
# OpenSearch Service environment.
|
1716
|
+
#
|
1717
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1718
|
+
#
|
1719
|
+
# @example Request syntax with placeholder values
|
1720
|
+
#
|
1721
|
+
# resp = client.delete_direct_query_data_source({
|
1722
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
1723
|
+
# })
|
1724
|
+
#
|
1725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDirectQueryDataSource AWS API Documentation
|
1726
|
+
#
|
1727
|
+
# @overload delete_direct_query_data_source(params = {})
|
1728
|
+
# @param [Hash] params ({})
|
1729
|
+
def delete_direct_query_data_source(params = {}, options = {})
|
1730
|
+
req = build_request(:delete_direct_query_data_source, params)
|
1731
|
+
req.send_request(options)
|
1732
|
+
end
|
1733
|
+
|
1528
1734
|
# Deletes an Amazon OpenSearch Service domain and all of its data. You
|
1529
1735
|
# can't recover a domain after you delete it.
|
1530
1736
|
#
|
@@ -1780,7 +1986,7 @@ module Aws::OpenSearchService
|
|
1780
1986
|
#
|
1781
1987
|
# resp.package_details.package_id #=> String
|
1782
1988
|
# resp.package_details.package_name #=> String
|
1783
|
-
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
1989
|
+
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
1784
1990
|
# resp.package_details.package_description #=> String
|
1785
1991
|
# resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
1786
1992
|
# resp.package_details.created_at #=> Time
|
@@ -1794,6 +2000,16 @@ module Aws::OpenSearchService
|
|
1794
2000
|
# resp.package_details.available_plugin_properties.version #=> String
|
1795
2001
|
# resp.package_details.available_plugin_properties.class_name #=> String
|
1796
2002
|
# resp.package_details.available_plugin_properties.uncompressed_size_in_bytes #=> Integer
|
2003
|
+
# resp.package_details.available_package_configuration.license_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
2004
|
+
# resp.package_details.available_package_configuration.license_filepath #=> String
|
2005
|
+
# resp.package_details.available_package_configuration.configuration_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
2006
|
+
# resp.package_details.available_package_configuration.requires_restart_for_configuration_update #=> Boolean
|
2007
|
+
# resp.package_details.allow_listed_user_list #=> Array
|
2008
|
+
# resp.package_details.allow_listed_user_list[0] #=> String
|
2009
|
+
# resp.package_details.package_owner #=> String
|
2010
|
+
# resp.package_details.package_vending_options.vending_enabled #=> Boolean
|
2011
|
+
# resp.package_details.package_encryption_options.kms_key_identifier #=> String
|
2012
|
+
# resp.package_details.package_encryption_options.encryption_enabled #=> Boolean
|
1797
2013
|
#
|
1798
2014
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage AWS API Documentation
|
1799
2015
|
#
|
@@ -2931,7 +3147,7 @@ module Aws::OpenSearchService
|
|
2931
3147
|
# resp = client.describe_packages({
|
2932
3148
|
# filters: [
|
2933
3149
|
# {
|
2934
|
-
# name: "PackageID", # accepts PackageID, PackageName, PackageStatus, PackageType, EngineVersion
|
3150
|
+
# name: "PackageID", # accepts PackageID, PackageName, PackageStatus, PackageType, EngineVersion, PackageOwner
|
2935
3151
|
# value: ["DescribePackagesFilterValue"],
|
2936
3152
|
# },
|
2937
3153
|
# ],
|
@@ -2944,7 +3160,7 @@ module Aws::OpenSearchService
|
|
2944
3160
|
# resp.package_details_list #=> Array
|
2945
3161
|
# resp.package_details_list[0].package_id #=> String
|
2946
3162
|
# resp.package_details_list[0].package_name #=> String
|
2947
|
-
# resp.package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
3163
|
+
# resp.package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
2948
3164
|
# resp.package_details_list[0].package_description #=> String
|
2949
3165
|
# resp.package_details_list[0].package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
2950
3166
|
# resp.package_details_list[0].created_at #=> Time
|
@@ -2958,6 +3174,16 @@ module Aws::OpenSearchService
|
|
2958
3174
|
# resp.package_details_list[0].available_plugin_properties.version #=> String
|
2959
3175
|
# resp.package_details_list[0].available_plugin_properties.class_name #=> String
|
2960
3176
|
# resp.package_details_list[0].available_plugin_properties.uncompressed_size_in_bytes #=> Integer
|
3177
|
+
# resp.package_details_list[0].available_package_configuration.license_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
3178
|
+
# resp.package_details_list[0].available_package_configuration.license_filepath #=> String
|
3179
|
+
# resp.package_details_list[0].available_package_configuration.configuration_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
3180
|
+
# resp.package_details_list[0].available_package_configuration.requires_restart_for_configuration_update #=> Boolean
|
3181
|
+
# resp.package_details_list[0].allow_listed_user_list #=> Array
|
3182
|
+
# resp.package_details_list[0].allow_listed_user_list[0] #=> String
|
3183
|
+
# resp.package_details_list[0].package_owner #=> String
|
3184
|
+
# resp.package_details_list[0].package_vending_options.vending_enabled #=> Boolean
|
3185
|
+
# resp.package_details_list[0].package_encryption_options.kms_key_identifier #=> String
|
3186
|
+
# resp.package_details_list[0].package_encryption_options.encryption_enabled #=> Boolean
|
2961
3187
|
# resp.next_token #=> String
|
2962
3188
|
#
|
2963
3189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages AWS API Documentation
|
@@ -3176,14 +3402,18 @@ module Aws::OpenSearchService
|
|
3176
3402
|
#
|
3177
3403
|
# resp.domain_package_details.package_id #=> String
|
3178
3404
|
# resp.domain_package_details.package_name #=> String
|
3179
|
-
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
3405
|
+
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
3180
3406
|
# resp.domain_package_details.last_updated #=> Time
|
3181
3407
|
# resp.domain_package_details.domain_name #=> String
|
3182
3408
|
# resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
3183
3409
|
# resp.domain_package_details.package_version #=> String
|
3410
|
+
# resp.domain_package_details.prerequisite_package_id_list #=> Array
|
3411
|
+
# resp.domain_package_details.prerequisite_package_id_list[0] #=> String
|
3184
3412
|
# resp.domain_package_details.reference_path #=> String
|
3185
3413
|
# resp.domain_package_details.error_details.error_type #=> String
|
3186
3414
|
# resp.domain_package_details.error_details.error_message #=> String
|
3415
|
+
# resp.domain_package_details.association_configuration.key_store_access_option.key_access_role_arn #=> String
|
3416
|
+
# resp.domain_package_details.association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
3187
3417
|
#
|
3188
3418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage AWS API Documentation
|
3189
3419
|
#
|
@@ -3194,6 +3424,54 @@ module Aws::OpenSearchService
|
|
3194
3424
|
req.send_request(options)
|
3195
3425
|
end
|
3196
3426
|
|
3427
|
+
# Dissociates multiple packages from a domain simulatneously.
|
3428
|
+
#
|
3429
|
+
# @option params [required, Array<String>] :package_list
|
3430
|
+
# A list of package IDs to be dissociated from a domain.
|
3431
|
+
#
|
3432
|
+
# @option params [required, String] :domain_name
|
3433
|
+
# The name of an OpenSearch Service domain. Domain names are unique
|
3434
|
+
# across the domains owned by an account within an Amazon Web Services
|
3435
|
+
# Region.
|
3436
|
+
#
|
3437
|
+
# @return [Types::DissociatePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3438
|
+
#
|
3439
|
+
# * {Types::DissociatePackagesResponse#domain_package_details_list #domain_package_details_list} => Array<Types::DomainPackageDetails>
|
3440
|
+
#
|
3441
|
+
# @example Request syntax with placeholder values
|
3442
|
+
#
|
3443
|
+
# resp = client.dissociate_packages({
|
3444
|
+
# package_list: ["PackageID"], # required
|
3445
|
+
# domain_name: "DomainName", # required
|
3446
|
+
# })
|
3447
|
+
#
|
3448
|
+
# @example Response structure
|
3449
|
+
#
|
3450
|
+
# resp.domain_package_details_list #=> Array
|
3451
|
+
# resp.domain_package_details_list[0].package_id #=> String
|
3452
|
+
# resp.domain_package_details_list[0].package_name #=> String
|
3453
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
3454
|
+
# resp.domain_package_details_list[0].last_updated #=> Time
|
3455
|
+
# resp.domain_package_details_list[0].domain_name #=> String
|
3456
|
+
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
3457
|
+
# resp.domain_package_details_list[0].package_version #=> String
|
3458
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list #=> Array
|
3459
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list[0] #=> String
|
3460
|
+
# resp.domain_package_details_list[0].reference_path #=> String
|
3461
|
+
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
3462
|
+
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
3463
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_access_role_arn #=> String
|
3464
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
3465
|
+
#
|
3466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackages AWS API Documentation
|
3467
|
+
#
|
3468
|
+
# @overload dissociate_packages(params = {})
|
3469
|
+
# @param [Hash] params ({})
|
3470
|
+
def dissociate_packages(params = {}, options = {})
|
3471
|
+
req = build_request(:dissociate_packages, params)
|
3472
|
+
req.send_request(options)
|
3473
|
+
end
|
3474
|
+
|
3197
3475
|
# Check the configuration and status of an existing OpenSearch
|
3198
3476
|
# Application.
|
3199
3477
|
#
|
@@ -3319,6 +3597,46 @@ module Aws::OpenSearchService
|
|
3319
3597
|
req.send_request(options)
|
3320
3598
|
end
|
3321
3599
|
|
3600
|
+
# Returns detailed configuration information for a specific direct query
|
3601
|
+
# data source in Amazon OpenSearch Service.
|
3602
|
+
#
|
3603
|
+
# @option params [required, String] :data_source_name
|
3604
|
+
# A unique, user-defined label that identifies the data source within
|
3605
|
+
# your OpenSearch Service environment.
|
3606
|
+
#
|
3607
|
+
# @return [Types::GetDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3608
|
+
#
|
3609
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_name #data_source_name} => String
|
3610
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_type #data_source_type} => Types::DirectQueryDataSourceType
|
3611
|
+
# * {Types::GetDirectQueryDataSourceResponse#description #description} => String
|
3612
|
+
# * {Types::GetDirectQueryDataSourceResponse#open_search_arns #open_search_arns} => Array<String>
|
3613
|
+
# * {Types::GetDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
3614
|
+
#
|
3615
|
+
# @example Request syntax with placeholder values
|
3616
|
+
#
|
3617
|
+
# resp = client.get_direct_query_data_source({
|
3618
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
3619
|
+
# })
|
3620
|
+
#
|
3621
|
+
# @example Response structure
|
3622
|
+
#
|
3623
|
+
# resp.data_source_name #=> String
|
3624
|
+
# resp.data_source_type.cloud_watch_log.role_arn #=> String
|
3625
|
+
# resp.data_source_type.security_lake.role_arn #=> String
|
3626
|
+
# resp.description #=> String
|
3627
|
+
# resp.open_search_arns #=> Array
|
3628
|
+
# resp.open_search_arns[0] #=> String
|
3629
|
+
# resp.data_source_arn #=> String
|
3630
|
+
#
|
3631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDirectQueryDataSource AWS API Documentation
|
3632
|
+
#
|
3633
|
+
# @overload get_direct_query_data_source(params = {})
|
3634
|
+
# @param [Hash] params ({})
|
3635
|
+
def get_direct_query_data_source(params = {}, options = {})
|
3636
|
+
req = build_request(:get_direct_query_data_source, params)
|
3637
|
+
req.send_request(options)
|
3638
|
+
end
|
3639
|
+
|
3322
3640
|
# The status of the maintenance action.
|
3323
3641
|
#
|
3324
3642
|
# @option params [required, String] :domain_name
|
@@ -3411,6 +3729,10 @@ module Aws::OpenSearchService
|
|
3411
3729
|
# resp.package_version_history_list[0].plugin_properties.version #=> String
|
3412
3730
|
# resp.package_version_history_list[0].plugin_properties.class_name #=> String
|
3413
3731
|
# resp.package_version_history_list[0].plugin_properties.uncompressed_size_in_bytes #=> Integer
|
3732
|
+
# resp.package_version_history_list[0].package_configuration.license_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
3733
|
+
# resp.package_version_history_list[0].package_configuration.license_filepath #=> String
|
3734
|
+
# resp.package_version_history_list[0].package_configuration.configuration_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
3735
|
+
# resp.package_version_history_list[0].package_configuration.requires_restart_for_configuration_update #=> Boolean
|
3414
3736
|
# resp.next_token #=> String
|
3415
3737
|
#
|
3416
3738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory AWS API Documentation
|
@@ -3599,6 +3921,49 @@ module Aws::OpenSearchService
|
|
3599
3921
|
req.send_request(options)
|
3600
3922
|
end
|
3601
3923
|
|
3924
|
+
# Lists an inventory of all the direct query data sources that you have
|
3925
|
+
# configured within Amazon OpenSearch Service.
|
3926
|
+
#
|
3927
|
+
# @option params [String] :next_token
|
3928
|
+
# When `nextToken` is returned, there are more results available. The
|
3929
|
+
# value of `nextToken` is a unique pagination token for each page. Send
|
3930
|
+
# the request again using the returned token to retrieve the next page.
|
3931
|
+
#
|
3932
|
+
# @return [Types::ListDirectQueryDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3933
|
+
#
|
3934
|
+
# * {Types::ListDirectQueryDataSourcesResponse#next_token #next_token} => String
|
3935
|
+
# * {Types::ListDirectQueryDataSourcesResponse#direct_query_data_sources #direct_query_data_sources} => Array<Types::DirectQueryDataSource>
|
3936
|
+
#
|
3937
|
+
# @example Request syntax with placeholder values
|
3938
|
+
#
|
3939
|
+
# resp = client.list_direct_query_data_sources({
|
3940
|
+
# next_token: "NextToken",
|
3941
|
+
# })
|
3942
|
+
#
|
3943
|
+
# @example Response structure
|
3944
|
+
#
|
3945
|
+
# resp.next_token #=> String
|
3946
|
+
# resp.direct_query_data_sources #=> Array
|
3947
|
+
# resp.direct_query_data_sources[0].data_source_name #=> String
|
3948
|
+
# resp.direct_query_data_sources[0].data_source_type.cloud_watch_log.role_arn #=> String
|
3949
|
+
# resp.direct_query_data_sources[0].data_source_type.security_lake.role_arn #=> String
|
3950
|
+
# resp.direct_query_data_sources[0].description #=> String
|
3951
|
+
# resp.direct_query_data_sources[0].open_search_arns #=> Array
|
3952
|
+
# resp.direct_query_data_sources[0].open_search_arns[0] #=> String
|
3953
|
+
# resp.direct_query_data_sources[0].data_source_arn #=> String
|
3954
|
+
# resp.direct_query_data_sources[0].tag_list #=> Array
|
3955
|
+
# resp.direct_query_data_sources[0].tag_list[0].key #=> String
|
3956
|
+
# resp.direct_query_data_sources[0].tag_list[0].value #=> String
|
3957
|
+
#
|
3958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDirectQueryDataSources AWS API Documentation
|
3959
|
+
#
|
3960
|
+
# @overload list_direct_query_data_sources(params = {})
|
3961
|
+
# @param [Hash] params ({})
|
3962
|
+
def list_direct_query_data_sources(params = {}, options = {})
|
3963
|
+
req = build_request(:list_direct_query_data_sources, params)
|
3964
|
+
req.send_request(options)
|
3965
|
+
end
|
3966
|
+
|
3602
3967
|
# A list of maintenance actions for the domain.
|
3603
3968
|
#
|
3604
3969
|
# @option params [required, String] :domain_name
|
@@ -3732,14 +4097,18 @@ module Aws::OpenSearchService
|
|
3732
4097
|
# resp.domain_package_details_list #=> Array
|
3733
4098
|
# resp.domain_package_details_list[0].package_id #=> String
|
3734
4099
|
# resp.domain_package_details_list[0].package_name #=> String
|
3735
|
-
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
4100
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
3736
4101
|
# resp.domain_package_details_list[0].last_updated #=> Time
|
3737
4102
|
# resp.domain_package_details_list[0].domain_name #=> String
|
3738
4103
|
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
3739
4104
|
# resp.domain_package_details_list[0].package_version #=> String
|
4105
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list #=> Array
|
4106
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list[0] #=> String
|
3740
4107
|
# resp.domain_package_details_list[0].reference_path #=> String
|
3741
4108
|
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
3742
4109
|
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
4110
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_access_role_arn #=> String
|
4111
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
3743
4112
|
# resp.next_token #=> String
|
3744
4113
|
#
|
3745
4114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage AWS API Documentation
|
@@ -3863,14 +4232,18 @@ module Aws::OpenSearchService
|
|
3863
4232
|
# resp.domain_package_details_list #=> Array
|
3864
4233
|
# resp.domain_package_details_list[0].package_id #=> String
|
3865
4234
|
# resp.domain_package_details_list[0].package_name #=> String
|
3866
|
-
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
4235
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
3867
4236
|
# resp.domain_package_details_list[0].last_updated #=> Time
|
3868
4237
|
# resp.domain_package_details_list[0].domain_name #=> String
|
3869
4238
|
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
3870
4239
|
# resp.domain_package_details_list[0].package_version #=> String
|
4240
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list #=> Array
|
4241
|
+
# resp.domain_package_details_list[0].prerequisite_package_id_list[0] #=> String
|
3871
4242
|
# resp.domain_package_details_list[0].reference_path #=> String
|
3872
4243
|
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
3873
4244
|
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
4245
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_access_role_arn #=> String
|
4246
|
+
# resp.domain_package_details_list[0].association_configuration.key_store_access_option.key_store_access_enabled #=> Boolean
|
3874
4247
|
# resp.next_token #=> String
|
3875
4248
|
#
|
3876
4249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomain AWS API Documentation
|
@@ -3942,15 +4315,17 @@ module Aws::OpenSearchService
|
|
3942
4315
|
req.send_request(options)
|
3943
4316
|
end
|
3944
4317
|
|
3945
|
-
# Returns all resource tags for an Amazon OpenSearch Service domain
|
3946
|
-
# more information, see [Tagging Amazon
|
4318
|
+
# Returns all resource tags for an Amazon OpenSearch Service domain,
|
4319
|
+
# data source, or application. For more information, see [Tagging Amazon
|
4320
|
+
# OpenSearch Service resources][1].
|
3947
4321
|
#
|
3948
4322
|
#
|
3949
4323
|
#
|
3950
4324
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html
|
3951
4325
|
#
|
3952
4326
|
# @option params [required, String] :arn
|
3953
|
-
# Amazon Resource Name (ARN) for the domain
|
4327
|
+
# Amazon Resource Name (ARN) for the domain, data source, or application
|
4328
|
+
# to view tags for.
|
3954
4329
|
#
|
3955
4330
|
# @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3956
4331
|
#
|
@@ -4216,19 +4591,20 @@ module Aws::OpenSearchService
|
|
4216
4591
|
end
|
4217
4592
|
|
4218
4593
|
# Removes the specified set of tags from an Amazon OpenSearch Service
|
4219
|
-
# domain. For more information, see [
|
4220
|
-
#
|
4594
|
+
# domain, data source, or application. For more information, see [
|
4595
|
+
# Tagging Amazon OpenSearch Service resources][1].
|
4221
4596
|
#
|
4222
4597
|
#
|
4223
4598
|
#
|
4224
4599
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
|
4225
4600
|
#
|
4226
4601
|
# @option params [required, String] :arn
|
4227
|
-
# The Amazon Resource Name (ARN) of the domain
|
4228
|
-
# delete the specified tags.
|
4602
|
+
# The Amazon Resource Name (ARN) of the domain, data source, or
|
4603
|
+
# application from which you want to delete the specified tags.
|
4229
4604
|
#
|
4230
4605
|
# @option params [required, Array<String>] :tag_keys
|
4231
|
-
# The list of tag keys to remove from the domain
|
4606
|
+
# The list of tag keys to remove from the domain, data source, or
|
4607
|
+
# application.
|
4232
4608
|
#
|
4233
4609
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4234
4610
|
#
|
@@ -4505,6 +4881,58 @@ module Aws::OpenSearchService
|
|
4505
4881
|
req.send_request(options)
|
4506
4882
|
end
|
4507
4883
|
|
4884
|
+
# Updates the configuration or properties of an existing direct query
|
4885
|
+
# data source in Amazon OpenSearch Service.
|
4886
|
+
#
|
4887
|
+
# @option params [required, String] :data_source_name
|
4888
|
+
# A unique, user-defined label to identify the data source within your
|
4889
|
+
# OpenSearch Service environment.
|
4890
|
+
#
|
4891
|
+
# @option params [required, Types::DirectQueryDataSourceType] :data_source_type
|
4892
|
+
# The supported Amazon Web Services service that you want to use as the
|
4893
|
+
# source for direct queries in OpenSearch Service.
|
4894
|
+
#
|
4895
|
+
# @option params [String] :description
|
4896
|
+
# An optional text field for providing additional context and details
|
4897
|
+
# about the data source.
|
4898
|
+
#
|
4899
|
+
# @option params [required, Array<String>] :open_search_arns
|
4900
|
+
# A list of Amazon Resource Names (ARNs) for the OpenSearch collections
|
4901
|
+
# that are associated with the direct query data source.
|
4902
|
+
#
|
4903
|
+
# @return [Types::UpdateDirectQueryDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4904
|
+
#
|
4905
|
+
# * {Types::UpdateDirectQueryDataSourceResponse#data_source_arn #data_source_arn} => String
|
4906
|
+
#
|
4907
|
+
# @example Request syntax with placeholder values
|
4908
|
+
#
|
4909
|
+
# resp = client.update_direct_query_data_source({
|
4910
|
+
# data_source_name: "DirectQueryDataSourceName", # required
|
4911
|
+
# data_source_type: { # required
|
4912
|
+
# cloud_watch_log: {
|
4913
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
4914
|
+
# },
|
4915
|
+
# security_lake: {
|
4916
|
+
# role_arn: "DirectQueryDataSourceRoleArn", # required
|
4917
|
+
# },
|
4918
|
+
# },
|
4919
|
+
# description: "DirectQueryDataSourceDescription",
|
4920
|
+
# open_search_arns: ["ARN"], # required
|
4921
|
+
# })
|
4922
|
+
#
|
4923
|
+
# @example Response structure
|
4924
|
+
#
|
4925
|
+
# resp.data_source_arn #=> String
|
4926
|
+
#
|
4927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDirectQueryDataSource AWS API Documentation
|
4928
|
+
#
|
4929
|
+
# @overload update_direct_query_data_source(params = {})
|
4930
|
+
# @param [Hash] params ({})
|
4931
|
+
def update_direct_query_data_source(params = {}, options = {})
|
4932
|
+
req = build_request(:update_direct_query_data_source, params)
|
4933
|
+
req.send_request(options)
|
4934
|
+
end
|
4935
|
+
|
4508
4936
|
# Modifies the cluster configuration of the specified Amazon OpenSearch
|
4509
4937
|
# Service domain.
|
4510
4938
|
#
|
@@ -5009,6 +5437,12 @@ module Aws::OpenSearchService
|
|
5009
5437
|
# Commit message for the updated file, which is shown as part of
|
5010
5438
|
# `GetPackageVersionHistoryResponse`.
|
5011
5439
|
#
|
5440
|
+
# @option params [Types::PackageConfiguration] :package_configuration
|
5441
|
+
# The updated configuration details for a package.
|
5442
|
+
#
|
5443
|
+
# @option params [Types::PackageEncryptionOptions] :package_encryption_options
|
5444
|
+
# Encryption options for a package.
|
5445
|
+
#
|
5012
5446
|
# @return [Types::UpdatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5013
5447
|
#
|
5014
5448
|
# * {Types::UpdatePackageResponse#package_details #package_details} => Types::PackageDetails
|
@@ -5023,13 +5457,23 @@ module Aws::OpenSearchService
|
|
5023
5457
|
# },
|
5024
5458
|
# package_description: "PackageDescription",
|
5025
5459
|
# commit_message: "CommitMessage",
|
5460
|
+
# package_configuration: {
|
5461
|
+
# license_requirement: "REQUIRED", # required, accepts REQUIRED, OPTIONAL, NONE
|
5462
|
+
# license_filepath: "LicenseFilepath",
|
5463
|
+
# configuration_requirement: "REQUIRED", # required, accepts REQUIRED, OPTIONAL, NONE
|
5464
|
+
# requires_restart_for_configuration_update: false,
|
5465
|
+
# },
|
5466
|
+
# package_encryption_options: {
|
5467
|
+
# kms_key_identifier: "KmsKeyId",
|
5468
|
+
# encryption_enabled: false, # required
|
5469
|
+
# },
|
5026
5470
|
# })
|
5027
5471
|
#
|
5028
5472
|
# @example Response structure
|
5029
5473
|
#
|
5030
5474
|
# resp.package_details.package_id #=> String
|
5031
5475
|
# resp.package_details.package_name #=> String
|
5032
|
-
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN"
|
5476
|
+
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY", "ZIP-PLUGIN", "PACKAGE-LICENSE", "PACKAGE-CONFIG"
|
5033
5477
|
# resp.package_details.package_description #=> String
|
5034
5478
|
# resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
5035
5479
|
# resp.package_details.created_at #=> Time
|
@@ -5043,6 +5487,16 @@ module Aws::OpenSearchService
|
|
5043
5487
|
# resp.package_details.available_plugin_properties.version #=> String
|
5044
5488
|
# resp.package_details.available_plugin_properties.class_name #=> String
|
5045
5489
|
# resp.package_details.available_plugin_properties.uncompressed_size_in_bytes #=> Integer
|
5490
|
+
# resp.package_details.available_package_configuration.license_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
5491
|
+
# resp.package_details.available_package_configuration.license_filepath #=> String
|
5492
|
+
# resp.package_details.available_package_configuration.configuration_requirement #=> String, one of "REQUIRED", "OPTIONAL", "NONE"
|
5493
|
+
# resp.package_details.available_package_configuration.requires_restart_for_configuration_update #=> Boolean
|
5494
|
+
# resp.package_details.allow_listed_user_list #=> Array
|
5495
|
+
# resp.package_details.allow_listed_user_list[0] #=> String
|
5496
|
+
# resp.package_details.package_owner #=> String
|
5497
|
+
# resp.package_details.package_vending_options.vending_enabled #=> Boolean
|
5498
|
+
# resp.package_details.package_encryption_options.kms_key_identifier #=> String
|
5499
|
+
# resp.package_details.package_encryption_options.encryption_enabled #=> Boolean
|
5046
5500
|
#
|
5047
5501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackage AWS API Documentation
|
5048
5502
|
#
|
@@ -5053,6 +5507,49 @@ module Aws::OpenSearchService
|
|
5053
5507
|
req.send_request(options)
|
5054
5508
|
end
|
5055
5509
|
|
5510
|
+
# Updates the scope of a package. Scope of the package defines users who
|
5511
|
+
# can view and associate a package.
|
5512
|
+
#
|
5513
|
+
# @option params [required, String] :package_id
|
5514
|
+
# ID of the package whose scope is being updated.
|
5515
|
+
#
|
5516
|
+
# @option params [required, String] :operation
|
5517
|
+
# The operation to perform on the package scope (e.g.,
|
5518
|
+
# add/remove/override users).
|
5519
|
+
#
|
5520
|
+
# @option params [required, Array<String>] :package_user_list
|
5521
|
+
# List of users to be added or removed from the package scope.
|
5522
|
+
#
|
5523
|
+
# @return [Types::UpdatePackageScopeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5524
|
+
#
|
5525
|
+
# * {Types::UpdatePackageScopeResponse#package_id #package_id} => String
|
5526
|
+
# * {Types::UpdatePackageScopeResponse#operation #operation} => String
|
5527
|
+
# * {Types::UpdatePackageScopeResponse#package_user_list #package_user_list} => Array<String>
|
5528
|
+
#
|
5529
|
+
# @example Request syntax with placeholder values
|
5530
|
+
#
|
5531
|
+
# resp = client.update_package_scope({
|
5532
|
+
# package_id: "PackageID", # required
|
5533
|
+
# operation: "ADD", # required, accepts ADD, OVERRIDE, REMOVE
|
5534
|
+
# package_user_list: ["PackageUser"], # required
|
5535
|
+
# })
|
5536
|
+
#
|
5537
|
+
# @example Response structure
|
5538
|
+
#
|
5539
|
+
# resp.package_id #=> String
|
5540
|
+
# resp.operation #=> String, one of "ADD", "OVERRIDE", "REMOVE"
|
5541
|
+
# resp.package_user_list #=> Array
|
5542
|
+
# resp.package_user_list[0] #=> String
|
5543
|
+
#
|
5544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageScope AWS API Documentation
|
5545
|
+
#
|
5546
|
+
# @overload update_package_scope(params = {})
|
5547
|
+
# @param [Hash] params ({})
|
5548
|
+
def update_package_scope(params = {}, options = {})
|
5549
|
+
req = build_request(:update_package_scope, params)
|
5550
|
+
req.send_request(options)
|
5551
|
+
end
|
5552
|
+
|
5056
5553
|
# Reschedules a planned domain configuration change for a later time.
|
5057
5554
|
# This change can be a scheduled [service software update][1] or a
|
5058
5555
|
# [blue/green Auto-Tune enhancement][2].
|
@@ -5267,7 +5764,7 @@ module Aws::OpenSearchService
|
|
5267
5764
|
tracer: tracer
|
5268
5765
|
)
|
5269
5766
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
5270
|
-
context[:gem_version] = '1.
|
5767
|
+
context[:gem_version] = '1.62.0'
|
5271
5768
|
Seahorse::Client::Request.new(handlers, context)
|
5272
5769
|
end
|
5273
5770
|
|