aws-sdk-opensearchservice 1.11.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
30
30
  require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
33
- require 'aws-sdk-core/plugins/signature_v4.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
34
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
35
 
36
36
  Aws::Plugins::GlobalConfiguration.add_identifier(:opensearchservice)
@@ -79,8 +79,9 @@ module Aws::OpenSearchService
79
79
  add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
80
  add_plugin(Aws::Plugins::DefaultsMode)
81
81
  add_plugin(Aws::Plugins::RecursionDetection)
82
- add_plugin(Aws::Plugins::SignatureV4)
82
+ add_plugin(Aws::Plugins::Sign)
83
83
  add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::OpenSearchService::Plugins::Endpoints)
84
85
 
85
86
  # @overload initialize(options)
86
87
  # @param [Hash] options
@@ -287,6 +288,19 @@ module Aws::OpenSearchService
287
288
  # ** Please note ** When response stubbing is enabled, no HTTP
288
289
  # requests are made, and retries are disabled.
289
290
  #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
290
304
  # @option options [Boolean] :use_dualstack_endpoint
291
305
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
306
  # will be used if available.
@@ -300,6 +314,9 @@ module Aws::OpenSearchService
300
314
  # When `true`, request parameters are validated before
301
315
  # sending the request.
302
316
  #
317
+ # @option options [Aws::OpenSearchService::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::OpenSearchService::EndpointParameters`
319
+ #
303
320
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
304
321
  # requests through. Formatted like 'http://proxy.com:123'.
305
322
  #
@@ -351,11 +368,17 @@ module Aws::OpenSearchService
351
368
 
352
369
  # @!group API Operations
353
370
 
354
- # Allows the remote domain owner to accept an inbound cross-cluster
355
- # connection request.
371
+ # Allows the destination Amazon OpenSearch Service domain owner to
372
+ # accept an inbound cross-cluster search connection request. For more
373
+ # information, see [Cross-cluster search for Amazon OpenSearch
374
+ # Service][1].
375
+ #
376
+ #
377
+ #
378
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
356
379
  #
357
380
  # @option params [required, String] :connection_id
358
- # The ID of the inbound connection you want to accept.
381
+ # The ID of the inbound connection to accept.
359
382
  #
360
383
  # @return [Types::AcceptInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
361
384
  #
@@ -388,19 +411,21 @@ module Aws::OpenSearchService
388
411
  req.send_request(options)
389
412
  end
390
413
 
391
- # Attaches tags to an existing domain. Tags are a set of case-sensitive
392
- # key value pairs. An domain can have up to 10 tags. See [ Tagging
393
- # Amazon OpenSearch Service domains][1] for more information.
414
+ # Attaches tags to an existing Amazon OpenSearch Service domain. Tags
415
+ # are a set of case-sensitive key-value pairs. An domain can have up to
416
+ # 10 tags. For more information, see [ Tagging Amazon OpenSearch Service
417
+ # domains][1].
394
418
  #
395
419
  #
396
420
  #
397
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
421
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
398
422
  #
399
423
  # @option params [required, String] :arn
400
- # Specify the `ARN` of the domain you want to add tags to.
424
+ # Amazon Resource Name (ARN) for the OpenSearch Service domain to which
425
+ # you want to attach resource tags.
401
426
  #
402
427
  # @option params [required, Array<Types::Tag>] :tag_list
403
- # List of `Tag` to add to the domain.
428
+ # List of resource tags.
404
429
  #
405
430
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
406
431
  #
@@ -425,14 +450,20 @@ module Aws::OpenSearchService
425
450
  req.send_request(options)
426
451
  end
427
452
 
428
- # Associates a package with an Amazon OpenSearch Service domain.
453
+ # Associates a package with an Amazon OpenSearch Service domain. For
454
+ # more information, see [Custom packages for Amazon OpenSearch
455
+ # Service][1].
456
+ #
457
+ #
458
+ #
459
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
429
460
  #
430
461
  # @option params [required, String] :package_id
431
462
  # Internal ID of the package to associate with a domain. Use
432
463
  # `DescribePackages` to find this value.
433
464
  #
434
465
  # @option params [required, String] :domain_name
435
- # The name of the domain to associate the package with.
466
+ # Name of the domain to associate the package with.
436
467
  #
437
468
  # @return [Types::AssociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
438
469
  #
@@ -467,14 +498,53 @@ module Aws::OpenSearchService
467
498
  req.send_request(options)
468
499
  end
469
500
 
501
+ # Provides access to an Amazon OpenSearch Service domain through the use
502
+ # of an interface VPC endpoint.
503
+ #
504
+ # @option params [required, String] :domain_name
505
+ # The name of the OpenSearch Service domain to provide access to.
506
+ #
507
+ # @option params [required, String] :account
508
+ # The Amazon Web Services account ID to grant access to.
509
+ #
510
+ # @return [Types::AuthorizeVpcEndpointAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
511
+ #
512
+ # * {Types::AuthorizeVpcEndpointAccessResponse#authorized_principal #authorized_principal} => Types::AuthorizedPrincipal
513
+ #
514
+ # @example Request syntax with placeholder values
515
+ #
516
+ # resp = client.authorize_vpc_endpoint_access({
517
+ # domain_name: "DomainName", # required
518
+ # account: "AWSAccount", # required
519
+ # })
520
+ #
521
+ # @example Response structure
522
+ #
523
+ # resp.authorized_principal.principal_type #=> String, one of "AWS_ACCOUNT", "AWS_SERVICE"
524
+ # resp.authorized_principal.principal #=> String
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess AWS API Documentation
527
+ #
528
+ # @overload authorize_vpc_endpoint_access(params = {})
529
+ # @param [Hash] params ({})
530
+ def authorize_vpc_endpoint_access(params = {}, options = {})
531
+ req = build_request(:authorize_vpc_endpoint_access, params)
532
+ req.send_request(options)
533
+ end
534
+
470
535
  # Cancels a scheduled service software update for an Amazon OpenSearch
471
536
  # Service domain. You can only perform this operation before the
472
- # `AutomatedUpdateDate` and when the `UpdateStatus` is in the
473
- # `PENDING_UPDATE` state.
537
+ # `AutomatedUpdateDate` and when the domain's `UpdateStatus` is
538
+ # `PENDING_UPDATE`. For more information, see [Service software updates
539
+ # in Amazon OpenSearch Service][1].
540
+ #
541
+ #
542
+ #
543
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
474
544
  #
475
545
  # @option params [required, String] :domain_name
476
- # The name of the domain that you want to stop the latest service
477
- # software update on.
546
+ # Name of the OpenSearch Service domain that you want to cancel the
547
+ # service software update on.
478
548
  #
479
549
  # @return [Types::CancelServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
480
550
  #
@@ -506,96 +576,116 @@ module Aws::OpenSearchService
506
576
  req.send_request(options)
507
577
  end
508
578
 
509
- # Creates a new Amazon OpenSearch Service domain. For more information,
510
- # see [Creating and managing Amazon OpenSearch Service domains ][1] in
511
- # the *Amazon OpenSearch Service Developer Guide*.
579
+ # Creates an Amazon OpenSearch Service domain. For more information, see
580
+ # [Creating and managing Amazon OpenSearch Service domains][1].
512
581
  #
513
582
  #
514
583
  #
515
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html
584
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html
516
585
  #
517
586
  # @option params [required, String] :domain_name
518
- # The name of the Amazon OpenSearch Service domain you're creating.
519
- # Domain names are unique across the domains owned by an account within
520
- # an AWS region. Domain names must start with a lowercase letter and can
521
- # contain the following characters: a-z (lowercase), 0-9, and -
522
- # (hyphen).
587
+ # Name of the OpenSearch Service domain to create. Domain names are
588
+ # unique across the domains owned by an account within an Amazon Web
589
+ # Services Region.
523
590
  #
524
591
  # @option params [String] :engine_version
525
592
  # String of format Elasticsearch\_X.Y or OpenSearch\_X.Y to specify the
526
- # engine version for the Amazon OpenSearch Service domain. For example,
527
- # "OpenSearch\_1.0" or "Elasticsearch\_7.9". For more information,
528
- # see [Creating and managing Amazon OpenSearch Service domains ][1].
593
+ # engine version for the OpenSearch Service domain. For example,
594
+ # `OpenSearch_1.0` or `Elasticsearch_7.9`. For more information, see
595
+ # [Creating and managing Amazon OpenSearch Service domains][1].
529
596
  #
530
597
  #
531
598
  #
532
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains
599
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains
533
600
  #
534
601
  # @option params [Types::ClusterConfig] :cluster_config
535
- # Configuration options for a domain. Specifies the instance type and
536
- # number of instances in the domain.
602
+ # Container for the cluster configuration of a domain.
537
603
  #
538
604
  # @option params [Types::EBSOptions] :ebs_options
539
- # Options to enable, disable, and specify the type and size of EBS
540
- # storage volumes.
605
+ # Container for the parameters required to enable EBS-based storage for
606
+ # an OpenSearch Service domain.
541
607
  #
542
608
  # @option params [String] :access_policies
543
- # IAM access policy as a JSON-formatted string.
609
+ # Identity and Access Management (IAM) policy document specifying the
610
+ # access policies for the new domain.
544
611
  #
545
612
  # @option params [Types::SnapshotOptions] :snapshot_options
546
- # Option to set time, in UTC format, of the daily automated snapshot.
547
- # Default value is 0 hours.
613
+ # DEPRECATED. Container for the parameters required to configure
614
+ # automated snapshots of domain indexes.
548
615
  #
549
616
  # @option params [Types::VPCOptions] :vpc_options
550
- # Options to specify the subnets and security groups for a VPC endpoint.
551
- # For more information, see [Launching your Amazon OpenSearch Service
552
- # domains using a VPC ][1].
617
+ # Container for the values required to configure VPC access domains. If
618
+ # you don't specify these values, OpenSearch Service creates the domain
619
+ # with a public endpoint. For more information, see [Launching your
620
+ # Amazon OpenSearch Service domains using a VPC][1].
553
621
  #
554
622
  #
555
623
  #
556
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
624
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
557
625
  #
558
626
  # @option params [Types::CognitoOptions] :cognito_options
559
- # Options to specify the Cognito user and identity pools for OpenSearch
560
- # Dashboards authentication. For more information, see [Configuring
561
- # Amazon Cognito authentication for OpenSearch Dashboards][1].
627
+ # Key-value pairs to configure Amazon Cognito authentication. For more
628
+ # information, see [Configuring Amazon Cognito authentication for
629
+ # OpenSearch Dashboards][1].
562
630
  #
563
631
  #
564
632
  #
565
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
633
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
566
634
  #
567
635
  # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
568
- # Options for encryption of data at rest.
636
+ # Key-value pairs to enable encryption at rest.
569
637
  #
570
638
  # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
571
- # Node-to-node encryption options.
639
+ # Enables node-to-node encryption.
572
640
  #
573
641
  # @option params [Hash<String,String>] :advanced_options
574
- # Option to allow references to indices in an HTTP request body. Must be
575
- # `false` when configuring access to individual sub-resources. By
576
- # default, the value is `true`. See [Advanced cluster parameters ][1]
577
- # for more information.
642
+ # Key-value pairs to specify advanced configuration options. The
643
+ # following key-value pairs are supported:
644
+ #
645
+ # * `"rest.action.multi.allow_explicit_index": "true" | "false"` - Note
646
+ # the use of a string rather than a boolean. Specifies whether
647
+ # explicit references to indexes are allowed inside the body of HTTP
648
+ # requests. If you want to configure access policies for domain
649
+ # sub-resources, such as specific indexes and domain APIs, you must
650
+ # disable this property. Default is true.
651
+ #
652
+ # * `"indices.fielddata.cache.size": "80" ` - Note the use of a string
653
+ # rather than a boolean. Specifies the percentage of heap space
654
+ # allocated to field data. Default is unbounded.
578
655
  #
656
+ # * `"indices.query.bool.max_clause_count": "1024"` - Note the use of a
657
+ # string rather than a boolean. Specifies the maximum number of
658
+ # clauses allowed in a Lucene boolean query. Default is 1,024. Queries
659
+ # with more than the permitted number of clauses result in a
660
+ # `TooManyClauses` error.
579
661
  #
662
+ # * `"override_main_response_version": "true" | "false"` - Note the use
663
+ # of a string rather than a boolean. Specifies whether the domain
664
+ # reports its version as 7.10 to allow Elasticsearch OSS clients and
665
+ # plugins to continue working with it. Default is false when creating
666
+ # a domain and true when upgrading a domain.
580
667
  #
581
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
668
+ # For more information, see [Advanced cluster parameters][1].
669
+ #
670
+ #
671
+ #
672
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
582
673
  #
583
674
  # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
584
- # Map of `LogType` and `LogPublishingOption`, each containing options to
585
- # publish a given type of OpenSearch log.
675
+ # Key-value pairs to configure slow log publishing.
586
676
  #
587
677
  # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
588
- # Options to specify configurations that will be applied to the domain
589
- # endpoint.
678
+ # Additional options for the domain endpoint, such as whether to require
679
+ # HTTPS for all traffic.
590
680
  #
591
681
  # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
592
- # Specifies advanced security options.
682
+ # Options for fine-grained access control.
593
683
  #
594
684
  # @option params [Array<Types::Tag>] :tag_list
595
- # A list of `Tag` added during domain creation.
685
+ # List of tags to add to the domain upon creation.
596
686
  #
597
687
  # @option params [Types::AutoTuneOptionsInput] :auto_tune_options
598
- # Specifies Auto-Tune options.
688
+ # Options for Auto-Tune.
599
689
  #
600
690
  # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
601
691
  #
@@ -797,18 +887,23 @@ module Aws::OpenSearchService
797
887
  req.send_request(options)
798
888
  end
799
889
 
800
- # Creates a new cross-cluster connection from a local OpenSearch domain
801
- # to a remote OpenSearch domain.
890
+ # Creates a new cross-cluster search connection from a source Amazon
891
+ # OpenSearch Service domain to a destination domain. For more
892
+ # information, see [Cross-cluster search for Amazon OpenSearch
893
+ # Service][1].
894
+ #
895
+ #
896
+ #
897
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
802
898
  #
803
899
  # @option params [required, Types::DomainInformationContainer] :local_domain_info
804
- # The ` AWSDomainInformation ` for the local OpenSearch domain.
900
+ # Name and Region of the source (local) domain.
805
901
  #
806
902
  # @option params [required, Types::DomainInformationContainer] :remote_domain_info
807
- # The ` AWSDomainInformation ` for the remote OpenSearch domain.
903
+ # Name and Region of the destination (remote) domain.
808
904
  #
809
905
  # @option params [required, String] :connection_alias
810
- # The connection alias used used by the customer for this cross-cluster
811
- # connection.
906
+ # Name of the connection.
812
907
  #
813
908
  # @return [Types::CreateOutboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
814
909
  #
@@ -860,13 +955,19 @@ module Aws::OpenSearchService
860
955
  req.send_request(options)
861
956
  end
862
957
 
863
- # Create a package for use with Amazon OpenSearch Service domains.
958
+ # Creates a package for use with Amazon OpenSearch Service domains. For
959
+ # more information, see [Custom packages for Amazon OpenSearch
960
+ # Service][1].
961
+ #
962
+ #
963
+ #
964
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
864
965
  #
865
966
  # @option params [required, String] :package_name
866
- # Unique identifier for the package.
967
+ # Unique name for the package.
867
968
  #
868
969
  # @option params [required, String] :package_type
869
- # Type of package. Currently supports only TXT-DICTIONARY.
970
+ # Type of package.
870
971
  #
871
972
  # @option params [String] :package_description
872
973
  # Description of the package.
@@ -912,8 +1013,59 @@ module Aws::OpenSearchService
912
1013
  req.send_request(options)
913
1014
  end
914
1015
 
915
- # Permanently deletes the specified domain and all of its data. Once a
916
- # domain is deleted, it cannot be recovered.
1016
+ # Creates an Amazon OpenSearch Service-managed VPC endpoint.
1017
+ #
1018
+ # @option params [required, String] :domain_arn
1019
+ # The Amazon Resource Name (ARN) of the domain to grant access to.
1020
+ #
1021
+ # @option params [required, Types::VPCOptions] :vpc_options
1022
+ # Options to specify the subnets and security groups for the endpoint.
1023
+ #
1024
+ # @option params [String] :client_token
1025
+ # Unique, case-sensitive identifier to ensure idempotency of the
1026
+ # request.
1027
+ #
1028
+ # @return [Types::CreateVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1029
+ #
1030
+ # * {Types::CreateVpcEndpointResponse#vpc_endpoint #vpc_endpoint} => Types::VpcEndpoint
1031
+ #
1032
+ # @example Request syntax with placeholder values
1033
+ #
1034
+ # resp = client.create_vpc_endpoint({
1035
+ # domain_arn: "DomainArn", # required
1036
+ # vpc_options: { # required
1037
+ # subnet_ids: ["String"],
1038
+ # security_group_ids: ["String"],
1039
+ # },
1040
+ # client_token: "ClientToken",
1041
+ # })
1042
+ #
1043
+ # @example Response structure
1044
+ #
1045
+ # resp.vpc_endpoint.vpc_endpoint_id #=> String
1046
+ # resp.vpc_endpoint.vpc_endpoint_owner #=> String
1047
+ # resp.vpc_endpoint.domain_arn #=> String
1048
+ # resp.vpc_endpoint.vpc_options.vpc_id #=> String
1049
+ # resp.vpc_endpoint.vpc_options.subnet_ids #=> Array
1050
+ # resp.vpc_endpoint.vpc_options.subnet_ids[0] #=> String
1051
+ # resp.vpc_endpoint.vpc_options.availability_zones #=> Array
1052
+ # resp.vpc_endpoint.vpc_options.availability_zones[0] #=> String
1053
+ # resp.vpc_endpoint.vpc_options.security_group_ids #=> Array
1054
+ # resp.vpc_endpoint.vpc_options.security_group_ids[0] #=> String
1055
+ # resp.vpc_endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
1056
+ # resp.vpc_endpoint.endpoint #=> String
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpoint AWS API Documentation
1059
+ #
1060
+ # @overload create_vpc_endpoint(params = {})
1061
+ # @param [Hash] params ({})
1062
+ def create_vpc_endpoint(params = {}, options = {})
1063
+ req = build_request(:create_vpc_endpoint, params)
1064
+ req.send_request(options)
1065
+ end
1066
+
1067
+ # Deletes an Amazon OpenSearch Service domain and all of its data. You
1068
+ # can't recover a domain after you delete it.
917
1069
  #
918
1070
  # @option params [required, String] :domain_name
919
1071
  # The name of the domain you want to permanently delete.
@@ -1015,8 +1167,14 @@ module Aws::OpenSearchService
1015
1167
  req.send_request(options)
1016
1168
  end
1017
1169
 
1018
- # Allows the remote domain owner to delete an existing inbound
1019
- # cross-cluster connection.
1170
+ # Allows the destination Amazon OpenSearch Service domain owner to
1171
+ # delete an existing inbound cross-cluster search connection. For more
1172
+ # information, see [Cross-cluster search for Amazon OpenSearch
1173
+ # Service][1].
1174
+ #
1175
+ #
1176
+ #
1177
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
1020
1178
  #
1021
1179
  # @option params [required, String] :connection_id
1022
1180
  # The ID of the inbound connection to permanently delete.
@@ -1052,8 +1210,14 @@ module Aws::OpenSearchService
1052
1210
  req.send_request(options)
1053
1211
  end
1054
1212
 
1055
- # Allows the local domain owner to delete an existing outbound
1056
- # cross-cluster connection.
1213
+ # Allows the source Amazon OpenSearch Service domain owner to delete an
1214
+ # existing outbound cross-cluster search connection. For more
1215
+ # information, see [Cross-cluster search for Amazon OpenSearch
1216
+ # Service][1].
1217
+ #
1218
+ #
1219
+ #
1220
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
1057
1221
  #
1058
1222
  # @option params [required, String] :connection_id
1059
1223
  # The ID of the outbound connection you want to permanently delete.
@@ -1090,7 +1254,12 @@ module Aws::OpenSearchService
1090
1254
  req.send_request(options)
1091
1255
  end
1092
1256
 
1093
- # Deletes the package.
1257
+ # Deletes an Amazon OpenSearch Service package. For more information,
1258
+ # see [Custom packages for Amazon OpenSearch Service][1].
1259
+ #
1260
+ #
1261
+ #
1262
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
1094
1263
  #
1095
1264
  # @option params [required, String] :package_id
1096
1265
  # The internal ID of the package you want to delete. Use
@@ -1128,11 +1297,43 @@ module Aws::OpenSearchService
1128
1297
  req.send_request(options)
1129
1298
  end
1130
1299
 
1131
- # Returns domain configuration information about the specified domain,
1132
- # including the domain ID, domain endpoint, and domain ARN.
1300
+ # Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
1301
+ #
1302
+ # @option params [required, String] :vpc_endpoint_id
1303
+ # The unique identifier of the endpoint.
1304
+ #
1305
+ # @return [Types::DeleteVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1306
+ #
1307
+ # * {Types::DeleteVpcEndpointResponse#vpc_endpoint_summary #vpc_endpoint_summary} => Types::VpcEndpointSummary
1308
+ #
1309
+ # @example Request syntax with placeholder values
1310
+ #
1311
+ # resp = client.delete_vpc_endpoint({
1312
+ # vpc_endpoint_id: "VpcEndpointId", # required
1313
+ # })
1314
+ #
1315
+ # @example Response structure
1316
+ #
1317
+ # resp.vpc_endpoint_summary.vpc_endpoint_id #=> String
1318
+ # resp.vpc_endpoint_summary.vpc_endpoint_owner #=> String
1319
+ # resp.vpc_endpoint_summary.domain_arn #=> String
1320
+ # resp.vpc_endpoint_summary.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
1321
+ #
1322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteVpcEndpoint AWS API Documentation
1323
+ #
1324
+ # @overload delete_vpc_endpoint(params = {})
1325
+ # @param [Hash] params ({})
1326
+ def delete_vpc_endpoint(params = {}, options = {})
1327
+ req = build_request(:delete_vpc_endpoint, params)
1328
+ req.send_request(options)
1329
+ end
1330
+
1331
+ # Describes the domain configuration for the specified Amazon OpenSearch
1332
+ # Service domain, including the domain ID, domain service endpoint, and
1333
+ # domain ARN.
1133
1334
  #
1134
1335
  # @option params [required, String] :domain_name
1135
- # The name of the domain for which you want information.
1336
+ # The name of the domain that you want information about.
1136
1337
  #
1137
1338
  # @return [Types::DescribeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1138
1339
  #
@@ -1231,19 +1432,26 @@ module Aws::OpenSearchService
1231
1432
  req.send_request(options)
1232
1433
  end
1233
1434
 
1234
- # Provides scheduled Auto-Tune action details for the domain, such as
1235
- # Auto-Tune action type, description, severity, and scheduled date.
1435
+ # Returns the list of optimizations that Auto-Tune has made to an Amazon
1436
+ # OpenSearch Service domain. For more information, see [Auto-Tune for
1437
+ # Amazon OpenSearch Service][1].
1438
+ #
1439
+ #
1440
+ #
1441
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
1236
1442
  #
1237
1443
  # @option params [required, String] :domain_name
1238
- # The domain name for which you want Auto-Tune action details.
1444
+ # Name of the domain that you want Auto-Tune details about.
1239
1445
  #
1240
1446
  # @option params [Integer] :max_results
1241
- # Set this value to limit the number of results returned. If not
1242
- # specified, defaults to 100.
1447
+ # An optional parameter that specifies the maximum number of results to
1448
+ # return. You can use `nextToken` to get the next page of results.
1243
1449
  #
1244
1450
  # @option params [String] :next_token
1245
- # NextToken is sent in case the earlier API call results contain the
1246
- # NextToken. Used for pagination.
1451
+ # If your initial `DescribeDomainAutoTunes` operation returns a
1452
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1453
+ # `DescribeDomainAutoTunes` operations, which returns results in the
1454
+ # next page.
1247
1455
  #
1248
1456
  # @return [Types::DescribeDomainAutoTunesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
1457
  #
@@ -1280,15 +1488,20 @@ module Aws::OpenSearchService
1280
1488
  end
1281
1489
 
1282
1490
  # Returns information about the current blue/green deployment happening
1283
- # on a domain, including a change ID, status, and progress stages.
1491
+ # on an Amazon OpenSearch Service domain. For more information, see
1492
+ # [Making configuration changes in Amazon OpenSearch Service][1].
1493
+ #
1494
+ #
1495
+ #
1496
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html
1284
1497
  #
1285
1498
  # @option params [required, String] :domain_name
1286
- # The domain you want to get the progress information about.
1499
+ # The name of the domain to get progress information for.
1287
1500
  #
1288
1501
  # @option params [String] :change_id
1289
1502
  # The specific change ID for which you want to get progress information.
1290
- # This is an optional parameter. If omitted, the service returns
1291
- # information about the most recent configuration change.
1503
+ # If omitted, the request returns information about the most recent
1504
+ # configuration change.
1292
1505
  #
1293
1506
  # @return [Types::DescribeDomainChangeProgressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1294
1507
  #
@@ -1326,12 +1539,11 @@ module Aws::OpenSearchService
1326
1539
  req.send_request(options)
1327
1540
  end
1328
1541
 
1329
- # Provides cluster configuration information about the specified domain,
1330
- # such as the state, creation date, update version, and update date for
1331
- # cluster options.
1542
+ # Returns the configuration of an Amazon OpenSearch Service domain.
1332
1543
  #
1333
1544
  # @option params [required, String] :domain_name
1334
- # The domain you want to get information about.
1545
+ # Name of the OpenSearch Service domain configuration that you want to
1546
+ # describe.
1335
1547
  #
1336
1548
  # @return [Types::DescribeDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1337
1549
  #
@@ -1488,11 +1700,13 @@ module Aws::OpenSearchService
1488
1700
  req.send_request(options)
1489
1701
  end
1490
1702
 
1491
- # Returns domain configuration information about the specified domains,
1492
- # including the domain ID, domain endpoint, and domain ARN.
1703
+ # Returns domain configuration information about the specified Amazon
1704
+ # OpenSearch Service domains.
1493
1705
  #
1494
1706
  # @option params [required, Array<String>] :domain_names
1495
- # The domains for which you want information.
1707
+ # Array of OpenSearch Service domain names that you want information
1708
+ # about. If you don't specify any domains, OpenSearch Service returns
1709
+ # information about all domains owned by the account.
1496
1710
  #
1497
1711
  # @return [Types::DescribeDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1498
1712
  #
@@ -1592,24 +1806,28 @@ module Aws::OpenSearchService
1592
1806
  req.send_request(options)
1593
1807
  end
1594
1808
 
1595
- # Lists all the inbound cross-cluster connections for a remote domain.
1809
+ # Lists all the inbound cross-cluster search connections for a
1810
+ # destination (remote) Amazon OpenSearch Service domain. For more
1811
+ # information, see [Cross-cluster search for Amazon OpenSearch
1812
+ # Service][1].
1813
+ #
1814
+ #
1815
+ #
1816
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
1596
1817
  #
1597
1818
  # @option params [Array<Types::Filter>] :filters
1598
1819
  # A list of filters used to match properties for inbound cross-cluster
1599
- # connections. Available ` Filter ` values are: * connection-id
1600
- # * local-domain-info.domain-name
1601
- # * local-domain-info.owner-id
1602
- # * local-domain-info.region
1603
- # * remote-domain-info.domain-name
1820
+ # connections.
1604
1821
  #
1605
1822
  # @option params [Integer] :max_results
1606
- # Set this value to limit the number of results returned. If not
1607
- # specified, defaults to 100.
1823
+ # An optional parameter that specifies the maximum number of results to
1824
+ # return. You can use `nextToken` to get the next page of results.
1608
1825
  #
1609
1826
  # @option params [String] :next_token
1610
- # If more results are available and NextToken is present, make the next
1611
- # request to the same API with the received NextToken to paginate the
1612
- # remaining results.
1827
+ # If your initial `DescribeInboundConnections` operation returns a
1828
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1829
+ # `DescribeInboundConnections` operations, which returns results in the
1830
+ # next page.
1613
1831
  #
1614
1832
  # @return [Types::DescribeInboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1615
1833
  #
@@ -1654,20 +1872,21 @@ module Aws::OpenSearchService
1654
1872
  req.send_request(options)
1655
1873
  end
1656
1874
 
1657
- # Describe the limits for a given instance type and OpenSearch or
1658
- # Elasticsearch version. When modifying an existing domain, specify the
1659
- # ` DomainName ` to see which limits you can modify.
1875
+ # Describes the instance count, storage, and master node limits for a
1876
+ # given OpenSearch or Elasticsearch version and instance type.
1660
1877
  #
1661
1878
  # @option params [String] :domain_name
1662
- # The name of the domain you want to modify. Only include this value if
1663
- # you're querying OpenSearch ` Limits ` for an existing domain.
1879
+ # The name of the domain. Only specify if you need the limits for an
1880
+ # existing domain.
1664
1881
  #
1665
1882
  # @option params [required, String] :instance_type
1666
- # The instance type for an OpenSearch cluster for which OpenSearch `
1667
- # Limits ` are needed.
1883
+ # The OpenSearch Service instance type for which you need limit
1884
+ # information.
1668
1885
  #
1669
1886
  # @option params [required, String] :engine_version
1670
- # Version of OpenSearch for which ` Limits ` are needed.
1887
+ # Version of OpenSearch or Elasticsearch, in the format
1888
+ # Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest version
1889
+ # of OpenSearch.
1671
1890
  #
1672
1891
  # @return [Types::DescribeInstanceTypeLimitsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1673
1892
  #
@@ -1707,24 +1926,26 @@ module Aws::OpenSearchService
1707
1926
  req.send_request(options)
1708
1927
  end
1709
1928
 
1710
- # Lists all the outbound cross-cluster connections for a local domain.
1929
+ # Lists all the outbound cross-cluster connections for a local (source)
1930
+ # Amazon OpenSearch Service domain. For more information, see
1931
+ # [Cross-cluster search for Amazon OpenSearch Service][1].
1932
+ #
1933
+ #
1934
+ #
1935
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
1711
1936
  #
1712
1937
  # @option params [Array<Types::Filter>] :filters
1713
- # A list of filters used to match properties for outbound cross-cluster
1714
- # connections. Available ` Filter ` names for this operation are: *
1715
- # connection-id
1716
- # * remote-domain-info.domain-name
1717
- # * remote-domain-info.owner-id
1718
- # * remote-domain-info.region
1719
- # * local-domain-info.domain-name
1938
+ # List of filter names and values that you can use for requests.
1720
1939
  #
1721
1940
  # @option params [Integer] :max_results
1722
- # Set this value to limit the number of results returned. If not
1723
- # specified, defaults to 100.
1941
+ # An optional parameter that specifies the maximum number of results to
1942
+ # return. You can use `nextToken` to get the next page of results.
1724
1943
  #
1725
1944
  # @option params [String] :next_token
1726
- # NextToken is sent in case the earlier API call results contain the
1727
- # NextToken parameter. Used for pagination.
1945
+ # If your initial `DescribeOutboundConnections` operation returns a
1946
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1947
+ # `DescribeOutboundConnections` operations, which returns results in the
1948
+ # next page.
1728
1949
  #
1729
1950
  # @return [Types::DescribeOutboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1730
1951
  #
@@ -1770,20 +1991,25 @@ module Aws::OpenSearchService
1770
1991
  req.send_request(options)
1771
1992
  end
1772
1993
 
1773
- # Describes all packages available to Amazon OpenSearch Service domains.
1774
- # Includes options for filtering, limiting the number of results, and
1775
- # pagination.
1994
+ # Describes all packages available to OpenSearch Service. For more
1995
+ # information, see [Custom packages for Amazon OpenSearch Service][1].
1996
+ #
1997
+ #
1998
+ #
1999
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
1776
2000
  #
1777
2001
  # @option params [Array<Types::DescribePackagesFilter>] :filters
1778
2002
  # Only returns packages that match the `DescribePackagesFilterList`
1779
2003
  # values.
1780
2004
  #
1781
2005
  # @option params [Integer] :max_results
1782
- # Limits results to a maximum number of packages.
2006
+ # An optional parameter that specifies the maximum number of results to
2007
+ # return. You can use `nextToken` to get the next page of results.
1783
2008
  #
1784
2009
  # @option params [String] :next_token
1785
- # Used for pagination. Only necessary if a previous API call includes a
1786
- # non-null NextToken value. If provided, returns results for the next
2010
+ # If your initial `DescribePackageFilters` operation returns a
2011
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2012
+ # `DescribePackageFilters` operations, which returns results in the next
1787
2013
  # page.
1788
2014
  #
1789
2015
  # @return [Types::DescribePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1830,19 +2056,28 @@ module Aws::OpenSearchService
1830
2056
  req.send_request(options)
1831
2057
  end
1832
2058
 
1833
- # Lists available reserved OpenSearch instance offerings.
2059
+ # Describes the available Amazon OpenSearch Service Reserved Instance
2060
+ # offerings for a given Region. For more information, see [Reserved
2061
+ # Instances in Amazon OpenSearch Service][1].
2062
+ #
2063
+ #
2064
+ #
2065
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html
1834
2066
  #
1835
2067
  # @option params [String] :reserved_instance_offering_id
1836
- # The offering identifier filter value. Use this parameter to show only
1837
- # the available offering that matches the specified reservation
1838
- # identifier.
2068
+ # The Reserved Instance identifier filter value. Use this parameter to
2069
+ # show only the available instance types that match the specified
2070
+ # reservation identifier.
1839
2071
  #
1840
2072
  # @option params [Integer] :max_results
1841
- # Set this value to limit the number of results returned. If not
1842
- # specified, defaults to 100.
2073
+ # An optional parameter that specifies the maximum number of results to
2074
+ # return. You can use `nextToken` to get the next page of results.
1843
2075
  #
1844
2076
  # @option params [String] :next_token
1845
- # Provides an identifier to allow retrieval of paginated results.
2077
+ # If your initial `DescribeReservedInstanceOfferings` operation returns
2078
+ # a `nextToken`, you can include the returned `nextToken` in subsequent
2079
+ # `DescribeReservedInstanceOfferings` operations, which returns results
2080
+ # in the next page.
1846
2081
  #
1847
2082
  # @return [Types::DescribeReservedInstanceOfferingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1848
2083
  #
@@ -1883,8 +2118,13 @@ module Aws::OpenSearchService
1883
2118
  req.send_request(options)
1884
2119
  end
1885
2120
 
1886
- # Returns information about reserved OpenSearch instances for this
1887
- # account.
2121
+ # Describes the Amazon OpenSearch Service instances that you have
2122
+ # reserved in a given Region. For more information, see [Reserved
2123
+ # Instances in Amazon OpenSearch Service][1].
2124
+ #
2125
+ #
2126
+ #
2127
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html
1888
2128
  #
1889
2129
  # @option params [String] :reserved_instance_id
1890
2130
  # The reserved instance identifier filter value. Use this parameter to
@@ -1892,11 +2132,14 @@ module Aws::OpenSearchService
1892
2132
  # OpenSearch instance ID.
1893
2133
  #
1894
2134
  # @option params [Integer] :max_results
1895
- # Set this value to limit the number of results returned. If not
1896
- # specified, defaults to 100.
2135
+ # An optional parameter that specifies the maximum number of results to
2136
+ # return. You can use `nextToken` to get the next page of results.
1897
2137
  #
1898
2138
  # @option params [String] :next_token
1899
- # Provides an identifier to allow retrieval of paginated results.
2139
+ # If your initial `DescribeReservedInstances` operation returns a
2140
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2141
+ # `DescribeReservedInstances` operations, which returns results in the
2142
+ # next page.
1900
2143
  #
1901
2144
  # @return [Types::DescribeReservedInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1902
2145
  #
@@ -1943,14 +2186,67 @@ module Aws::OpenSearchService
1943
2186
  req.send_request(options)
1944
2187
  end
1945
2188
 
1946
- # Dissociates a package from the Amazon OpenSearch Service domain.
2189
+ # Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
2190
+ #
2191
+ # @option params [required, Array<String>] :vpc_endpoint_ids
2192
+ # The unique identifiers of the endpoints to get information about.
2193
+ #
2194
+ # @return [Types::DescribeVpcEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2195
+ #
2196
+ # * {Types::DescribeVpcEndpointsResponse#vpc_endpoints #vpc_endpoints} => Array&lt;Types::VpcEndpoint&gt;
2197
+ # * {Types::DescribeVpcEndpointsResponse#vpc_endpoint_errors #vpc_endpoint_errors} => Array&lt;Types::VpcEndpointError&gt;
2198
+ #
2199
+ # @example Request syntax with placeholder values
2200
+ #
2201
+ # resp = client.describe_vpc_endpoints({
2202
+ # vpc_endpoint_ids: ["VpcEndpointId"], # required
2203
+ # })
2204
+ #
2205
+ # @example Response structure
2206
+ #
2207
+ # resp.vpc_endpoints #=> Array
2208
+ # resp.vpc_endpoints[0].vpc_endpoint_id #=> String
2209
+ # resp.vpc_endpoints[0].vpc_endpoint_owner #=> String
2210
+ # resp.vpc_endpoints[0].domain_arn #=> String
2211
+ # resp.vpc_endpoints[0].vpc_options.vpc_id #=> String
2212
+ # resp.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
2213
+ # resp.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
2214
+ # resp.vpc_endpoints[0].vpc_options.availability_zones #=> Array
2215
+ # resp.vpc_endpoints[0].vpc_options.availability_zones[0] #=> String
2216
+ # resp.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
2217
+ # resp.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
2218
+ # resp.vpc_endpoints[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
2219
+ # resp.vpc_endpoints[0].endpoint #=> String
2220
+ # resp.vpc_endpoint_errors #=> Array
2221
+ # resp.vpc_endpoint_errors[0].vpc_endpoint_id #=> String
2222
+ # resp.vpc_endpoint_errors[0].error_code #=> String, one of "ENDPOINT_NOT_FOUND", "SERVER_ERROR"
2223
+ # resp.vpc_endpoint_errors[0].error_message #=> String
2224
+ #
2225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeVpcEndpoints AWS API Documentation
2226
+ #
2227
+ # @overload describe_vpc_endpoints(params = {})
2228
+ # @param [Hash] params ({})
2229
+ def describe_vpc_endpoints(params = {}, options = {})
2230
+ req = build_request(:describe_vpc_endpoints, params)
2231
+ req.send_request(options)
2232
+ end
2233
+
2234
+ # Removes a package from the specified Amazon OpenSearch Service domain.
2235
+ # The package can't be in use with any OpenSearch index for the
2236
+ # dissociation to succeed. The package is still available in OpenSearch
2237
+ # Service for association later. For more information, see [Custom
2238
+ # packages for Amazon OpenSearch Service][1].
2239
+ #
2240
+ #
2241
+ #
2242
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
1947
2243
  #
1948
2244
  # @option params [required, String] :package_id
1949
- # The internal ID of the package to associate with a domain. Use
1950
- # `DescribePackages` to find this value.
2245
+ # Internal ID of the package to dissociate from the domain. Use
2246
+ # `ListPackagesForDomain` to find this value.
1951
2247
  #
1952
2248
  # @option params [required, String] :domain_name
1953
- # The name of the domain to associate the package with.
2249
+ # Name of the domain to dissociate the package from.
1954
2250
  #
1955
2251
  # @return [Types::DissociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1956
2252
  #
@@ -1985,16 +2281,12 @@ module Aws::OpenSearchService
1985
2281
  req.send_request(options)
1986
2282
  end
1987
2283
 
1988
- # Returns a list of upgrade-compatible versions of
1989
- # OpenSearch/Elasticsearch. You can optionally pass a ` DomainName ` to
1990
- # get all upgrade-compatible versions of OpenSearch/Elasticsearch for
1991
- # that specific domain.
2284
+ # Returns a map of OpenSearch or Elasticsearch versions and the versions
2285
+ # you can upgrade them to.
1992
2286
  #
1993
2287
  # @option params [String] :domain_name
1994
- # The name of an domain. Domain names are unique across the domains
1995
- # owned by an account within an AWS region. Domain names start with a
1996
- # letter or number and can contain the following characters: a-z
1997
- # (lowercase), 0-9, and - (hyphen).
2288
+ # The name of an existing domain. Provide this parameter to limit the
2289
+ # results to a single domain.
1998
2290
  #
1999
2291
  # @return [Types::GetCompatibleVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2000
2292
  #
@@ -2022,19 +2314,26 @@ module Aws::OpenSearchService
2022
2314
  req.send_request(options)
2023
2315
  end
2024
2316
 
2025
- # Returns a list of package versions, along with their creation time and
2026
- # commit message.
2317
+ # Returns a list of Amazon OpenSearch Service package versions, along
2318
+ # with their creation time and commit message. For more information, see
2319
+ # [Custom packages for Amazon OpenSearch Service][1].
2320
+ #
2321
+ #
2322
+ #
2323
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
2027
2324
  #
2028
2325
  # @option params [required, String] :package_id
2029
- # Returns an audit history of package versions.
2326
+ # The unique identifier of the package.
2030
2327
  #
2031
2328
  # @option params [Integer] :max_results
2032
- # Limits results to a maximum number of package versions.
2329
+ # An optional parameter that specifies the maximum number of results to
2330
+ # return. You can use `nextToken` to get the next page of results.
2033
2331
  #
2034
2332
  # @option params [String] :next_token
2035
- # Used for pagination. Only necessary if a previous API call includes a
2036
- # non-null NextToken value. If provided, returns results for the next
2037
- # page.
2333
+ # If your initial `GetPackageVersionHistory` operation returns a
2334
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2335
+ # `GetPackageVersionHistory` operations, which returns results in the
2336
+ # next page.
2038
2337
  #
2039
2338
  # @return [Types::GetPackageVersionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2040
2339
  #
@@ -2070,22 +2369,21 @@ module Aws::OpenSearchService
2070
2369
  req.send_request(options)
2071
2370
  end
2072
2371
 
2073
- # Retrieves the complete history of the last 10 upgrades performed on
2074
- # the domain.
2372
+ # Retrieves the complete history of the last 10 upgrades performed on an
2373
+ # Amazon OpenSearch Service domain.
2075
2374
  #
2076
2375
  # @option params [required, String] :domain_name
2077
- # The name of an domain. Domain names are unique across the domains
2078
- # owned by an account within an AWS region. Domain names start with a
2079
- # letter or number and can contain the following characters: a-z
2080
- # (lowercase), 0-9, and - (hyphen).
2376
+ # The name of an existing domain.
2081
2377
  #
2082
2378
  # @option params [Integer] :max_results
2083
- # Set this value to limit the number of results returned.
2379
+ # An optional parameter that specifies the maximum number of results to
2380
+ # return. You can use `nextToken` to get the next page of results.
2084
2381
  #
2085
2382
  # @option params [String] :next_token
2086
- # Paginated APIs accept the NextToken input to return the next page of
2087
- # results and provide a NextToken output in the response, which you can
2088
- # use to retrieve more results.
2383
+ # If your initial `GetUpgradeHistory` operation returns a `nextToken`,
2384
+ # you can include the returned `nextToken` in subsequent
2385
+ # `GetUpgradeHistory` operations, which returns results in the next
2386
+ # page.
2089
2387
  #
2090
2388
  # @return [Types::GetUpgradeHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2091
2389
  #
@@ -2125,14 +2423,11 @@ module Aws::OpenSearchService
2125
2423
  req.send_request(options)
2126
2424
  end
2127
2425
 
2128
- # Retrieves the latest status of the last upgrade or upgrade eligibility
2129
- # check performed on the domain.
2426
+ # Returns the most recent status of the last upgrade or upgrade
2427
+ # eligibility check performed on an Amazon OpenSearch Service domain.
2130
2428
  #
2131
2429
  # @option params [required, String] :domain_name
2132
- # The name of an domain. Domain names are unique across the domains
2133
- # owned by an account within an AWS region. Domain names start with a
2134
- # letter or number and can contain the following characters: a-z
2135
- # (lowercase), 0-9, and - (hyphen).
2430
+ # The domain of the domain to get upgrade status information for.
2136
2431
  #
2137
2432
  # @return [Types::GetUpgradeStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2138
2433
  #
@@ -2161,11 +2456,11 @@ module Aws::OpenSearchService
2161
2456
  req.send_request(options)
2162
2457
  end
2163
2458
 
2164
- # Returns the names of all domains owned by the current user's account.
2459
+ # Returns the names of all Amazon OpenSearch Service domains owned by
2460
+ # the current user in the active Region.
2165
2461
  #
2166
2462
  # @option params [String] :engine_type
2167
- # Optional parameter to filter the output by domain engine type.
2168
- # Acceptable values are 'Elasticsearch' and 'OpenSearch'.
2463
+ # Filters the output by domain engine type.
2169
2464
  #
2170
2465
  # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2171
2466
  #
@@ -2192,18 +2487,26 @@ module Aws::OpenSearchService
2192
2487
  req.send_request(options)
2193
2488
  end
2194
2489
 
2195
- # Lists all Amazon OpenSearch Service domains associated with the
2196
- # package.
2490
+ # Lists all Amazon OpenSearch Service domains associated with a given
2491
+ # package. For more information, see [Custom packages for Amazon
2492
+ # OpenSearch Service][1].
2493
+ #
2494
+ #
2495
+ #
2496
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
2197
2497
  #
2198
2498
  # @option params [required, String] :package_id
2199
- # The package for which to list associated domains.
2499
+ # The unique identifier of the package for which to list associated
2500
+ # domains.
2200
2501
  #
2201
2502
  # @option params [Integer] :max_results
2202
- # Limits the results to a maximum number of domains.
2503
+ # An optional parameter that specifies the maximum number of results to
2504
+ # return. You can use `nextToken` to get the next page of results.
2203
2505
  #
2204
2506
  # @option params [String] :next_token
2205
- # Used for pagination. Only necessary if a previous API call includes a
2206
- # non-null NextToken value. If provided, returns results for the next
2507
+ # If your initial `ListDomainsForPackage` operation returns a
2508
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2509
+ # `ListDomainsForPackage` operations, which returns results in the next
2207
2510
  # page.
2208
2511
  #
2209
2512
  # @return [Types::ListDomainsForPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2245,21 +2548,26 @@ module Aws::OpenSearchService
2245
2548
  req.send_request(options)
2246
2549
  end
2247
2550
 
2551
+ # Lists all instance types and available features for a given OpenSearch
2552
+ # or Elasticsearch version.
2553
+ #
2248
2554
  # @option params [required, String] :engine_version
2555
+ # Version of OpenSearch or Elasticsearch, in the format
2556
+ # Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest version
2557
+ # of OpenSearch.
2249
2558
  #
2250
2559
  # @option params [String] :domain_name
2251
- # The name of an domain. Domain names are unique across the domains
2252
- # owned by an account within an AWS region. Domain names start with a
2253
- # letter or number and can contain the following characters: a-z
2254
- # (lowercase), 0-9, and - (hyphen).
2560
+ # Name of the domain to list instance type details for.
2255
2561
  #
2256
2562
  # @option params [Integer] :max_results
2257
- # Set this value to limit the number of results returned.
2563
+ # An optional parameter that specifies the maximum number of results to
2564
+ # return. You can use `nextToken` to get the next page of results.
2258
2565
  #
2259
2566
  # @option params [String] :next_token
2260
- # Paginated APIs accept the NextToken input to return the next page of
2261
- # results and provide a NextToken output in the response, which you can
2262
- # use to retrieve more results.
2567
+ # If your initial `ListInstanceTypeDetails` operation returns a
2568
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2569
+ # `ListInstanceTypeDetails` operations, which returns results in the
2570
+ # next page.
2263
2571
  #
2264
2572
  # @return [Types::ListInstanceTypeDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2265
2573
  #
@@ -2299,18 +2607,25 @@ module Aws::OpenSearchService
2299
2607
  req.send_request(options)
2300
2608
  end
2301
2609
 
2302
- # Lists all packages associated with the Amazon OpenSearch Service
2303
- # domain.
2610
+ # Lists all packages associated with an Amazon OpenSearch Service
2611
+ # domain. For more information, see [Custom packages for Amazon
2612
+ # OpenSearch Service][1].
2613
+ #
2614
+ #
2615
+ #
2616
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
2304
2617
  #
2305
2618
  # @option params [required, String] :domain_name
2306
2619
  # The name of the domain for which you want to list associated packages.
2307
2620
  #
2308
2621
  # @option params [Integer] :max_results
2309
- # Limits results to a maximum number of packages.
2622
+ # An optional parameter that specifies the maximum number of results to
2623
+ # return. You can use `nextToken` to get the next page of results.
2310
2624
  #
2311
2625
  # @option params [String] :next_token
2312
- # Used for pagination. Only necessary if a previous API call includes a
2313
- # non-null NextToken value. If provided, returns results for the next
2626
+ # If your initial `ListPackagesForDomain` operation returns a
2627
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2628
+ # `ListPackagesForDomain` operations, which returns results in the next
2314
2629
  # page.
2315
2630
  #
2316
2631
  # @return [Types::ListPackagesForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2352,11 +2667,15 @@ module Aws::OpenSearchService
2352
2667
  req.send_request(options)
2353
2668
  end
2354
2669
 
2355
- # Returns all tags for the given domain.
2670
+ # Returns all resource tags for an Amazon OpenSearch Service domain. For
2671
+ # more information, see [Tagging Amazon OpenSearch Service domains][1].
2672
+ #
2673
+ #
2674
+ #
2675
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html
2356
2676
  #
2357
2677
  # @option params [required, String] :arn
2358
- # Specify the `ARN` of the domain that the tags you want to view are
2359
- # attached to.
2678
+ # Amazon Resource Name (ARN) for the domain to view tags for.
2360
2679
  #
2361
2680
  # @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2362
2681
  #
@@ -2383,16 +2702,17 @@ module Aws::OpenSearchService
2383
2702
  req.send_request(options)
2384
2703
  end
2385
2704
 
2386
- # List all supported versions of OpenSearch and Elasticsearch.
2705
+ # Lists all versions of OpenSearch and Elasticsearch that Amazon
2706
+ # OpenSearch Service supports.
2387
2707
  #
2388
2708
  # @option params [Integer] :max_results
2389
- # Set this value to limit the number of results returned. Value must be
2390
- # greater than 10 or it won't be honored.
2709
+ # An optional parameter that specifies the maximum number of results to
2710
+ # return. You can use `nextToken` to get the next page of results.
2391
2711
  #
2392
2712
  # @option params [String] :next_token
2393
- # Paginated APIs accept the NextToken input to return the next page of
2394
- # results and provide a NextToken output in the response, which you can
2395
- # use to retrieve more results.
2713
+ # If your initial `ListVersions` operation returns a `nextToken`, you
2714
+ # can include the returned `nextToken` in subsequent `ListVersions`
2715
+ # operations, which returns results in the next page.
2396
2716
  #
2397
2717
  # @return [Types::ListVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2398
2718
  #
@@ -2423,10 +2743,131 @@ module Aws::OpenSearchService
2423
2743
  req.send_request(options)
2424
2744
  end
2425
2745
 
2426
- # Allows you to purchase reserved OpenSearch instances.
2746
+ # Retrieves information about each Amazon Web Services principal that is
2747
+ # allowed to access a given Amazon OpenSearch Service domain through the
2748
+ # use of an interface VPC endpoint.
2749
+ #
2750
+ # @option params [required, String] :domain_name
2751
+ # The name of the OpenSearch Service domain to retrieve access
2752
+ # information for.
2753
+ #
2754
+ # @option params [String] :next_token
2755
+ # If your initial `ListVpcEndpointAccess` operation returns a
2756
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2757
+ # `ListVpcEndpointAccess` operations, which returns results in the next
2758
+ # page.
2759
+ #
2760
+ # @return [Types::ListVpcEndpointAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2761
+ #
2762
+ # * {Types::ListVpcEndpointAccessResponse#authorized_principal_list #authorized_principal_list} => Array&lt;Types::AuthorizedPrincipal&gt;
2763
+ # * {Types::ListVpcEndpointAccessResponse#next_token #next_token} => String
2764
+ #
2765
+ # @example Request syntax with placeholder values
2766
+ #
2767
+ # resp = client.list_vpc_endpoint_access({
2768
+ # domain_name: "DomainName", # required
2769
+ # next_token: "NextToken",
2770
+ # })
2771
+ #
2772
+ # @example Response structure
2773
+ #
2774
+ # resp.authorized_principal_list #=> Array
2775
+ # resp.authorized_principal_list[0].principal_type #=> String, one of "AWS_ACCOUNT", "AWS_SERVICE"
2776
+ # resp.authorized_principal_list[0].principal #=> String
2777
+ # resp.next_token #=> String
2778
+ #
2779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointAccess AWS API Documentation
2780
+ #
2781
+ # @overload list_vpc_endpoint_access(params = {})
2782
+ # @param [Hash] params ({})
2783
+ def list_vpc_endpoint_access(params = {}, options = {})
2784
+ req = build_request(:list_vpc_endpoint_access, params)
2785
+ req.send_request(options)
2786
+ end
2787
+
2788
+ # Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the
2789
+ # current Amazon Web Services account and Region.
2790
+ #
2791
+ # @option params [String] :next_token
2792
+ # If your initial `ListVpcEndpoints` operation returns a `nextToken`,
2793
+ # you can include the returned `nextToken` in subsequent
2794
+ # `ListVpcEndpoints` operations, which returns results in the next page.
2795
+ #
2796
+ # @return [Types::ListVpcEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2797
+ #
2798
+ # * {Types::ListVpcEndpointsResponse#vpc_endpoint_summary_list #vpc_endpoint_summary_list} => Array&lt;Types::VpcEndpointSummary&gt;
2799
+ # * {Types::ListVpcEndpointsResponse#next_token #next_token} => String
2800
+ #
2801
+ # @example Request syntax with placeholder values
2802
+ #
2803
+ # resp = client.list_vpc_endpoints({
2804
+ # next_token: "NextToken",
2805
+ # })
2806
+ #
2807
+ # @example Response structure
2808
+ #
2809
+ # resp.vpc_endpoint_summary_list #=> Array
2810
+ # resp.vpc_endpoint_summary_list[0].vpc_endpoint_id #=> String
2811
+ # resp.vpc_endpoint_summary_list[0].vpc_endpoint_owner #=> String
2812
+ # resp.vpc_endpoint_summary_list[0].domain_arn #=> String
2813
+ # resp.vpc_endpoint_summary_list[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
2814
+ # resp.next_token #=> String
2815
+ #
2816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpoints AWS API Documentation
2817
+ #
2818
+ # @overload list_vpc_endpoints(params = {})
2819
+ # @param [Hash] params ({})
2820
+ def list_vpc_endpoints(params = {}, options = {})
2821
+ req = build_request(:list_vpc_endpoints, params)
2822
+ req.send_request(options)
2823
+ end
2824
+
2825
+ # Retrieves all Amazon OpenSearch Service-managed VPC endpoints
2826
+ # associated with a particular domain.
2827
+ #
2828
+ # @option params [required, String] :domain_name
2829
+ # The name of the domain to list associated VPC endpoints for.
2830
+ #
2831
+ # @option params [String] :next_token
2832
+ # If your initial `ListEndpointsForDomain` operation returns a
2833
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2834
+ # `ListEndpointsForDomain` operations, which returns results in the next
2835
+ # page.
2836
+ #
2837
+ # @return [Types::ListVpcEndpointsForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2838
+ #
2839
+ # * {Types::ListVpcEndpointsForDomainResponse#vpc_endpoint_summary_list #vpc_endpoint_summary_list} => Array&lt;Types::VpcEndpointSummary&gt;
2840
+ # * {Types::ListVpcEndpointsForDomainResponse#next_token #next_token} => String
2841
+ #
2842
+ # @example Request syntax with placeholder values
2843
+ #
2844
+ # resp = client.list_vpc_endpoints_for_domain({
2845
+ # domain_name: "DomainName", # required
2846
+ # next_token: "NextToken",
2847
+ # })
2848
+ #
2849
+ # @example Response structure
2850
+ #
2851
+ # resp.vpc_endpoint_summary_list #=> Array
2852
+ # resp.vpc_endpoint_summary_list[0].vpc_endpoint_id #=> String
2853
+ # resp.vpc_endpoint_summary_list[0].vpc_endpoint_owner #=> String
2854
+ # resp.vpc_endpoint_summary_list[0].domain_arn #=> String
2855
+ # resp.vpc_endpoint_summary_list[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
2856
+ # resp.next_token #=> String
2857
+ #
2858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointsForDomain AWS API Documentation
2859
+ #
2860
+ # @overload list_vpc_endpoints_for_domain(params = {})
2861
+ # @param [Hash] params ({})
2862
+ def list_vpc_endpoints_for_domain(params = {}, options = {})
2863
+ req = build_request(:list_vpc_endpoints_for_domain, params)
2864
+ req.send_request(options)
2865
+ end
2866
+
2867
+ # Allows you to purchase Amazon OpenSearch Service Reserved Instances.
2427
2868
  #
2428
2869
  # @option params [required, String] :reserved_instance_offering_id
2429
- # The ID of the reserved OpenSearch instance offering to purchase.
2870
+ # The ID of the Reserved Instance offering to purchase.
2430
2871
  #
2431
2872
  # @option params [required, String] :reservation_name
2432
2873
  # A customer-specified identifier to track this reservation.
@@ -2461,11 +2902,11 @@ module Aws::OpenSearchService
2461
2902
  req.send_request(options)
2462
2903
  end
2463
2904
 
2464
- # Allows the remote domain owner to reject an inbound cross-cluster
2465
- # connection request.
2905
+ # Allows the remote Amazon OpenSearch Service domain owner to reject an
2906
+ # inbound cross-cluster connection request.
2466
2907
  #
2467
2908
  # @option params [required, String] :connection_id
2468
- # The ID of the inbound connection to reject.
2909
+ # The unique identifier of the inbound connection to reject.
2469
2910
  #
2470
2911
  # @return [Types::RejectInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2471
2912
  #
@@ -2498,14 +2939,20 @@ module Aws::OpenSearchService
2498
2939
  req.send_request(options)
2499
2940
  end
2500
2941
 
2501
- # Removes the specified set of tags from the given domain.
2942
+ # Removes the specified set of tags from an Amazon OpenSearch Service
2943
+ # domain. For more information, see [ Tagging Amazon OpenSearch Service
2944
+ # domains][1].
2945
+ #
2946
+ #
2947
+ #
2948
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
2502
2949
  #
2503
2950
  # @option params [required, String] :arn
2504
- # The `ARN` of the domain from which you want to delete the specified
2505
- # tags.
2951
+ # The Amazon Resource Name (ARN) of the domain from which you want to
2952
+ # delete the specified tags.
2506
2953
  #
2507
2954
  # @option params [required, Array<String>] :tag_keys
2508
- # The `TagKey` list you want to remove from the domain.
2955
+ # The list of tag keys to remove from the domain.
2509
2956
  #
2510
2957
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2511
2958
  #
@@ -2525,8 +2972,40 @@ module Aws::OpenSearchService
2525
2972
  req.send_request(options)
2526
2973
  end
2527
2974
 
2975
+ # Revokes access to an Amazon OpenSearch Service domain that was
2976
+ # provided through an interface VPC endpoint.
2977
+ #
2978
+ # @option params [required, String] :domain_name
2979
+ # The name of the OpenSearch Service domain.
2980
+ #
2981
+ # @option params [required, String] :account
2982
+ # The account ID to revoke access from.
2983
+ #
2984
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2985
+ #
2986
+ # @example Request syntax with placeholder values
2987
+ #
2988
+ # resp = client.revoke_vpc_endpoint_access({
2989
+ # domain_name: "DomainName", # required
2990
+ # account: "AWSAccount", # required
2991
+ # })
2992
+ #
2993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RevokeVpcEndpointAccess AWS API Documentation
2994
+ #
2995
+ # @overload revoke_vpc_endpoint_access(params = {})
2996
+ # @param [Hash] params ({})
2997
+ def revoke_vpc_endpoint_access(params = {}, options = {})
2998
+ req = build_request(:revoke_vpc_endpoint_access, params)
2999
+ req.send_request(options)
3000
+ end
3001
+
2528
3002
  # Schedules a service software update for an Amazon OpenSearch Service
2529
- # domain.
3003
+ # domain. For more information, see [Service software updates in Amazon
3004
+ # OpenSearch Service][1].
3005
+ #
3006
+ #
3007
+ #
3008
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
2530
3009
  #
2531
3010
  # @option params [required, String] :domain_name
2532
3011
  # The name of the domain that you want to update to the latest service
@@ -2562,78 +3041,97 @@ module Aws::OpenSearchService
2562
3041
  req.send_request(options)
2563
3042
  end
2564
3043
 
2565
- # Modifies the cluster configuration of the specified domain, such as
2566
- # setting the instance type and the number of instances.
3044
+ # Modifies the cluster configuration of the specified Amazon OpenSearch
3045
+ # Service domain.
2567
3046
  #
2568
3047
  # @option params [required, String] :domain_name
2569
- # The name of the domain you're updating.
3048
+ # The name of the domain that you're updating.
2570
3049
  #
2571
3050
  # @option params [Types::ClusterConfig] :cluster_config
2572
- # The type and number of instances to instantiate for the domain
2573
- # cluster.
3051
+ # Changes that you want to make to the cluster configuration, such as
3052
+ # the instance type and number of EC2 instances.
2574
3053
  #
2575
3054
  # @option params [Types::EBSOptions] :ebs_options
2576
- # Specify the type and size of the EBS volume to use.
3055
+ # The type and size of the EBS volume to attach to instances in the
3056
+ # domain.
2577
3057
  #
2578
3058
  # @option params [Types::SnapshotOptions] :snapshot_options
2579
3059
  # Option to set the time, in UTC format, for the daily automated
2580
3060
  # snapshot. Default value is `0` hours.
2581
3061
  #
2582
3062
  # @option params [Types::VPCOptions] :vpc_options
2583
- # Options to specify the subnets and security groups for the VPC
2584
- # endpoint. For more information, see [Launching your Amazon OpenSearch
2585
- # Service domains using a VPC ][1].
3063
+ # Options to specify the subnets and security groups for a VPC endpoint.
3064
+ # For more information, see [Launching your Amazon OpenSearch Service
3065
+ # domains using a VPC][1].
2586
3066
  #
2587
3067
  #
2588
3068
  #
2589
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
3069
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
2590
3070
  #
2591
3071
  # @option params [Types::CognitoOptions] :cognito_options
2592
- # Options to specify the Cognito user and identity pools for OpenSearch
2593
- # Dashboards authentication. For more information, see [Configuring
2594
- # Amazon Cognito authentication for OpenSearch Dashboards][1].
3072
+ # Key-value pairs to configure Amazon Cognito authentication for
3073
+ # OpenSearch Dashboards.
2595
3074
  #
3075
+ # @option params [Hash<String,String>] :advanced_options
3076
+ # Key-value pairs to specify advanced configuration options. The
3077
+ # following key-value pairs are supported:
2596
3078
  #
3079
+ # * `"rest.action.multi.allow_explicit_index": "true" | "false"` - Note
3080
+ # the use of a string rather than a boolean. Specifies whether
3081
+ # explicit references to indexes are allowed inside the body of HTTP
3082
+ # requests. If you want to configure access policies for domain
3083
+ # sub-resources, such as specific indexes and domain APIs, you must
3084
+ # disable this property. Default is true.
2597
3085
  #
2598
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
3086
+ # * `"indices.fielddata.cache.size": "80" ` - Note the use of a string
3087
+ # rather than a boolean. Specifies the percentage of heap space
3088
+ # allocated to field data. Default is unbounded.
2599
3089
  #
2600
- # @option params [Hash<String,String>] :advanced_options
2601
- # Modifies the advanced option to allow references to indices in an HTTP
2602
- # request body. Must be `false` when configuring access to individual
2603
- # sub-resources. By default, the value is `true`. See [Advanced options
2604
- # ][1] for more information.
3090
+ # * `"indices.query.bool.max_clause_count": "1024"` - Note the use of a
3091
+ # string rather than a boolean. Specifies the maximum number of
3092
+ # clauses allowed in a Lucene boolean query. Default is 1,024. Queries
3093
+ # with more than the permitted number of clauses result in a
3094
+ # `TooManyClauses` error.
2605
3095
  #
3096
+ # * `"override_main_response_version": "true" | "false"` - Note the use
3097
+ # of a string rather than a boolean. Specifies whether the domain
3098
+ # reports its version as 7.10 to allow Elasticsearch OSS clients and
3099
+ # plugins to continue working with it. Default is false when creating
3100
+ # a domain and true when upgrading a domain.
2606
3101
  #
3102
+ # For more information, see [Advanced cluster parameters][1].
2607
3103
  #
2608
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
3104
+ #
3105
+ #
3106
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
2609
3107
  #
2610
3108
  # @option params [String] :access_policies
2611
- # IAM access policy as a JSON-formatted string.
3109
+ # Identity and Access Management (IAM) access policy as a JSON-formatted
3110
+ # string.
2612
3111
  #
2613
3112
  # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
2614
- # Map of `LogType` and `LogPublishingOption`, each containing options to
2615
- # publish a given type of OpenSearch log.
3113
+ # Options to publish OpenSearch lots to Amazon CloudWatch Logs.
2616
3114
  #
2617
3115
  # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
2618
- # Specifies encryption of data at rest options.
3116
+ # Encryption at rest options for the domain.
2619
3117
  #
2620
3118
  # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
2621
- # Options to specify configuration that will be applied to the domain
2622
- # endpoint.
3119
+ # Additional options for the domain endpoint, such as whether to require
3120
+ # HTTPS for all traffic.
2623
3121
  #
2624
3122
  # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
2625
- # Specifies node-to-node encryption options.
3123
+ # Node-To-Node Encryption options for the domain.
2626
3124
  #
2627
3125
  # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
2628
- # Specifies advanced security options.
3126
+ # Options for fine-grained access control.
2629
3127
  #
2630
3128
  # @option params [Types::AutoTuneOptions] :auto_tune_options
2631
- # Specifies Auto-Tune options.
3129
+ # Options for Auto-Tune.
2632
3130
  #
2633
3131
  # @option params [Boolean] :dry_run
2634
3132
  # This flag, when set to True, specifies whether the `UpdateDomain`
2635
- # request should return the results of validation checks (DryRunResults)
2636
- # without actually applying the change.
3133
+ # request should return the results of validation check without actually
3134
+ # applying the change.
2637
3135
  #
2638
3136
  # @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2639
3137
  #
@@ -2891,20 +3389,25 @@ module Aws::OpenSearchService
2891
3389
  req.send_request(options)
2892
3390
  end
2893
3391
 
2894
- # Updates a package for use with Amazon OpenSearch Service domains.
3392
+ # Updates a package for use with Amazon OpenSearch Service domains. For
3393
+ # more information, see [Custom packages for Amazon OpenSearch
3394
+ # Service][1].
3395
+ #
3396
+ #
3397
+ #
3398
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
2895
3399
  #
2896
3400
  # @option params [required, String] :package_id
2897
3401
  # The unique identifier for the package.
2898
3402
  #
2899
3403
  # @option params [required, Types::PackageSource] :package_source
2900
- # The Amazon S3 location for importing the package specified as
2901
- # `S3BucketName` and `S3Key`
3404
+ # Amazon S3 bucket and key for the package.
2902
3405
  #
2903
3406
  # @option params [String] :package_description
2904
3407
  # A new description of the package.
2905
3408
  #
2906
3409
  # @option params [String] :commit_message
2907
- # A commit message for the new version which is shown as part of
3410
+ # Commit message for the updated file, which is shown as part of
2908
3411
  # `GetPackageVersionHistoryResponse`.
2909
3412
  #
2910
3413
  # @return [Types::UpdatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2945,40 +3448,73 @@ module Aws::OpenSearchService
2945
3448
  req.send_request(options)
2946
3449
  end
2947
3450
 
2948
- # Allows you to either upgrade your domain or perform an upgrade
2949
- # eligibility check to a compatible version of OpenSearch or
2950
- # Elasticsearch.
3451
+ # Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
3452
+ #
3453
+ # @option params [required, String] :vpc_endpoint_id
3454
+ # The unique identifier of the endpoint.
3455
+ #
3456
+ # @option params [required, Types::VPCOptions] :vpc_options
3457
+ # The security groups and/or subnets to add, remove, or modify.
3458
+ #
3459
+ # @return [Types::UpdateVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3460
+ #
3461
+ # * {Types::UpdateVpcEndpointResponse#vpc_endpoint #vpc_endpoint} => Types::VpcEndpoint
3462
+ #
3463
+ # @example Request syntax with placeholder values
3464
+ #
3465
+ # resp = client.update_vpc_endpoint({
3466
+ # vpc_endpoint_id: "VpcEndpointId", # required
3467
+ # vpc_options: { # required
3468
+ # subnet_ids: ["String"],
3469
+ # security_group_ids: ["String"],
3470
+ # },
3471
+ # })
3472
+ #
3473
+ # @example Response structure
3474
+ #
3475
+ # resp.vpc_endpoint.vpc_endpoint_id #=> String
3476
+ # resp.vpc_endpoint.vpc_endpoint_owner #=> String
3477
+ # resp.vpc_endpoint.domain_arn #=> String
3478
+ # resp.vpc_endpoint.vpc_options.vpc_id #=> String
3479
+ # resp.vpc_endpoint.vpc_options.subnet_ids #=> Array
3480
+ # resp.vpc_endpoint.vpc_options.subnet_ids[0] #=> String
3481
+ # resp.vpc_endpoint.vpc_options.availability_zones #=> Array
3482
+ # resp.vpc_endpoint.vpc_options.availability_zones[0] #=> String
3483
+ # resp.vpc_endpoint.vpc_options.security_group_ids #=> Array
3484
+ # resp.vpc_endpoint.vpc_options.security_group_ids[0] #=> String
3485
+ # resp.vpc_endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
3486
+ # resp.vpc_endpoint.endpoint #=> String
3487
+ #
3488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateVpcEndpoint AWS API Documentation
3489
+ #
3490
+ # @overload update_vpc_endpoint(params = {})
3491
+ # @param [Hash] params ({})
3492
+ def update_vpc_endpoint(params = {}, options = {})
3493
+ req = build_request(:update_vpc_endpoint, params)
3494
+ req.send_request(options)
3495
+ end
3496
+
3497
+ # Allows you to either upgrade your Amazon OpenSearch Service domain or
3498
+ # perform an upgrade eligibility check to a compatible version of
3499
+ # OpenSearch or Elasticsearch.
2951
3500
  #
2952
3501
  # @option params [required, String] :domain_name
2953
- # The name of an domain. Domain names are unique across the domains
2954
- # owned by an account within an AWS region. Domain names start with a
2955
- # letter or number and can contain the following characters: a-z
2956
- # (lowercase), 0-9, and - (hyphen).
3502
+ # Name of the OpenSearch Service domain that you want to upgrade.
2957
3503
  #
2958
3504
  # @option params [required, String] :target_version
2959
- # The version of OpenSearch you intend to upgrade the domain to.
3505
+ # OpenSearch or Elasticsearch version to which you want to upgrade, in
3506
+ # the format Opensearch\_X.Y or Elasticsearch\_X.Y.
2960
3507
  #
2961
3508
  # @option params [Boolean] :perform_check_only
2962
3509
  # When true, indicates that an upgrade eligibility check needs to be
2963
3510
  # performed. Does not actually perform the upgrade.
2964
3511
  #
2965
3512
  # @option params [Hash<String,String>] :advanced_options
2966
- # Exposes select native OpenSearch configuration values from
2967
- # `opensearch.yml`. Currently, the following advanced options are
2968
- # available:
2969
- #
2970
- # * Option to allow references to indices in an HTTP request body. Must
2971
- # be `false` when configuring access to individual sub-resources. By
2972
- # default, the value is `true`. See [Advanced cluster parameters ][1]
2973
- # for more information.
2974
- # * Option to specify the percentage of heap space allocated to field
2975
- # data. By default, this setting is unbounded.
2976
- #
2977
- # For more information, see [ Advanced cluster parameters][1].
2978
- #
2979
- #
2980
- #
2981
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
3513
+ # Only supports the `override_main_response_version` parameter and not
3514
+ # other advanced options. You can only include this option when
3515
+ # upgrading to an OpenSearch version. Specifies whether the domain
3516
+ # reports its version as 7.10 so that it continues to work with
3517
+ # Elasticsearch OSS clients and plugins.
2982
3518
  #
2983
3519
  # @return [Types::UpgradeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2984
3520
  #
@@ -3033,7 +3569,7 @@ module Aws::OpenSearchService
3033
3569
  params: params,
3034
3570
  config: config)
3035
3571
  context[:gem_name] = 'aws-sdk-opensearchservice'
3036
- context[:gem_version] = '1.11.0'
3572
+ context[:gem_version] = '1.13.0'
3037
3573
  Seahorse::Client::Request.new(handlers, context)
3038
3574
  end
3039
3575