aws-sdk-opensearchservice 1.12.0 → 1.13.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.
@@ -368,11 +368,17 @@ module Aws::OpenSearchService
368
368
 
369
369
  # @!group API Operations
370
370
 
371
- # Allows the remote domain owner to accept an inbound cross-cluster
372
- # 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
373
379
  #
374
380
  # @option params [required, String] :connection_id
375
- # The ID of the inbound connection you want to accept.
381
+ # The ID of the inbound connection to accept.
376
382
  #
377
383
  # @return [Types::AcceptInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
384
  #
@@ -405,19 +411,21 @@ module Aws::OpenSearchService
405
411
  req.send_request(options)
406
412
  end
407
413
 
408
- # Attaches tags to an existing domain. Tags are a set of case-sensitive
409
- # key value pairs. An domain can have up to 10 tags. See [ Tagging
410
- # 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].
411
418
  #
412
419
  #
413
420
  #
414
- # [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
415
422
  #
416
423
  # @option params [required, String] :arn
417
- # 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.
418
426
  #
419
427
  # @option params [required, Array<Types::Tag>] :tag_list
420
- # List of `Tag` to add to the domain.
428
+ # List of resource tags.
421
429
  #
422
430
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
423
431
  #
@@ -442,14 +450,20 @@ module Aws::OpenSearchService
442
450
  req.send_request(options)
443
451
  end
444
452
 
445
- # 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
446
460
  #
447
461
  # @option params [required, String] :package_id
448
462
  # Internal ID of the package to associate with a domain. Use
449
463
  # `DescribePackages` to find this value.
450
464
  #
451
465
  # @option params [required, String] :domain_name
452
- # The name of the domain to associate the package with.
466
+ # Name of the domain to associate the package with.
453
467
  #
454
468
  # @return [Types::AssociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
455
469
  #
@@ -484,14 +498,53 @@ module Aws::OpenSearchService
484
498
  req.send_request(options)
485
499
  end
486
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
+
487
535
  # Cancels a scheduled service software update for an Amazon OpenSearch
488
536
  # Service domain. You can only perform this operation before the
489
- # `AutomatedUpdateDate` and when the `UpdateStatus` is in the
490
- # `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
491
544
  #
492
545
  # @option params [required, String] :domain_name
493
- # The name of the domain that you want to stop the latest service
494
- # software update on.
546
+ # Name of the OpenSearch Service domain that you want to cancel the
547
+ # service software update on.
495
548
  #
496
549
  # @return [Types::CancelServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
497
550
  #
@@ -523,96 +576,116 @@ module Aws::OpenSearchService
523
576
  req.send_request(options)
524
577
  end
525
578
 
526
- # Creates a new Amazon OpenSearch Service domain. For more information,
527
- # see [Creating and managing Amazon OpenSearch Service domains ][1] in
528
- # 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].
529
581
  #
530
582
  #
531
583
  #
532
- # [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
533
585
  #
534
586
  # @option params [required, String] :domain_name
535
- # The name of the Amazon OpenSearch Service domain you're creating.
536
- # Domain names are unique across the domains owned by an account within
537
- # an AWS region. Domain names must start with a lowercase letter and can
538
- # contain the following characters: a-z (lowercase), 0-9, and -
539
- # (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.
540
590
  #
541
591
  # @option params [String] :engine_version
542
592
  # String of format Elasticsearch\_X.Y or OpenSearch\_X.Y to specify the
543
- # engine version for the Amazon OpenSearch Service domain. For example,
544
- # "OpenSearch\_1.0" or "Elasticsearch\_7.9". For more information,
545
- # 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].
546
596
  #
547
597
  #
548
598
  #
549
- # [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
550
600
  #
551
601
  # @option params [Types::ClusterConfig] :cluster_config
552
- # Configuration options for a domain. Specifies the instance type and
553
- # number of instances in the domain.
602
+ # Container for the cluster configuration of a domain.
554
603
  #
555
604
  # @option params [Types::EBSOptions] :ebs_options
556
- # Options to enable, disable, and specify the type and size of EBS
557
- # storage volumes.
605
+ # Container for the parameters required to enable EBS-based storage for
606
+ # an OpenSearch Service domain.
558
607
  #
559
608
  # @option params [String] :access_policies
560
- # 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.
561
611
  #
562
612
  # @option params [Types::SnapshotOptions] :snapshot_options
563
- # Option to set time, in UTC format, of the daily automated snapshot.
564
- # Default value is 0 hours.
613
+ # DEPRECATED. Container for the parameters required to configure
614
+ # automated snapshots of domain indexes.
565
615
  #
566
616
  # @option params [Types::VPCOptions] :vpc_options
567
- # Options to specify the subnets and security groups for a VPC endpoint.
568
- # For more information, see [Launching your Amazon OpenSearch Service
569
- # 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].
570
621
  #
571
622
  #
572
623
  #
573
- # [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
574
625
  #
575
626
  # @option params [Types::CognitoOptions] :cognito_options
576
- # Options to specify the Cognito user and identity pools for OpenSearch
577
- # Dashboards authentication. For more information, see [Configuring
578
- # 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].
579
630
  #
580
631
  #
581
632
  #
582
- # [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
583
634
  #
584
635
  # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
585
- # Options for encryption of data at rest.
636
+ # Key-value pairs to enable encryption at rest.
586
637
  #
587
638
  # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
588
- # Node-to-node encryption options.
639
+ # Enables node-to-node encryption.
589
640
  #
590
641
  # @option params [Hash<String,String>] :advanced_options
591
- # Option to allow references to indices in an HTTP request body. Must be
592
- # `false` when configuring access to individual sub-resources. By
593
- # default, the value is `true`. See [Advanced cluster parameters ][1]
594
- # 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.
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.
595
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.
596
667
  #
668
+ # For more information, see [Advanced cluster parameters][1].
597
669
  #
598
- # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
670
+ #
671
+ #
672
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
599
673
  #
600
674
  # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
601
- # Map of `LogType` and `LogPublishingOption`, each containing options to
602
- # publish a given type of OpenSearch log.
675
+ # Key-value pairs to configure slow log publishing.
603
676
  #
604
677
  # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
605
- # Options to specify configurations that will be applied to the domain
606
- # endpoint.
678
+ # Additional options for the domain endpoint, such as whether to require
679
+ # HTTPS for all traffic.
607
680
  #
608
681
  # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
609
- # Specifies advanced security options.
682
+ # Options for fine-grained access control.
610
683
  #
611
684
  # @option params [Array<Types::Tag>] :tag_list
612
- # A list of `Tag` added during domain creation.
685
+ # List of tags to add to the domain upon creation.
613
686
  #
614
687
  # @option params [Types::AutoTuneOptionsInput] :auto_tune_options
615
- # Specifies Auto-Tune options.
688
+ # Options for Auto-Tune.
616
689
  #
617
690
  # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
618
691
  #
@@ -814,18 +887,23 @@ module Aws::OpenSearchService
814
887
  req.send_request(options)
815
888
  end
816
889
 
817
- # Creates a new cross-cluster connection from a local OpenSearch domain
818
- # 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
819
898
  #
820
899
  # @option params [required, Types::DomainInformationContainer] :local_domain_info
821
- # The ` AWSDomainInformation ` for the local OpenSearch domain.
900
+ # Name and Region of the source (local) domain.
822
901
  #
823
902
  # @option params [required, Types::DomainInformationContainer] :remote_domain_info
824
- # The ` AWSDomainInformation ` for the remote OpenSearch domain.
903
+ # Name and Region of the destination (remote) domain.
825
904
  #
826
905
  # @option params [required, String] :connection_alias
827
- # The connection alias used used by the customer for this cross-cluster
828
- # connection.
906
+ # Name of the connection.
829
907
  #
830
908
  # @return [Types::CreateOutboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
831
909
  #
@@ -877,13 +955,19 @@ module Aws::OpenSearchService
877
955
  req.send_request(options)
878
956
  end
879
957
 
880
- # 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
881
965
  #
882
966
  # @option params [required, String] :package_name
883
- # Unique identifier for the package.
967
+ # Unique name for the package.
884
968
  #
885
969
  # @option params [required, String] :package_type
886
- # Type of package. Currently supports only TXT-DICTIONARY.
970
+ # Type of package.
887
971
  #
888
972
  # @option params [String] :package_description
889
973
  # Description of the package.
@@ -929,8 +1013,59 @@ module Aws::OpenSearchService
929
1013
  req.send_request(options)
930
1014
  end
931
1015
 
932
- # Permanently deletes the specified domain and all of its data. Once a
933
- # 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.
934
1069
  #
935
1070
  # @option params [required, String] :domain_name
936
1071
  # The name of the domain you want to permanently delete.
@@ -1032,8 +1167,14 @@ module Aws::OpenSearchService
1032
1167
  req.send_request(options)
1033
1168
  end
1034
1169
 
1035
- # Allows the remote domain owner to delete an existing inbound
1036
- # 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
1037
1178
  #
1038
1179
  # @option params [required, String] :connection_id
1039
1180
  # The ID of the inbound connection to permanently delete.
@@ -1069,8 +1210,14 @@ module Aws::OpenSearchService
1069
1210
  req.send_request(options)
1070
1211
  end
1071
1212
 
1072
- # Allows the local domain owner to delete an existing outbound
1073
- # 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
1074
1221
  #
1075
1222
  # @option params [required, String] :connection_id
1076
1223
  # The ID of the outbound connection you want to permanently delete.
@@ -1107,7 +1254,12 @@ module Aws::OpenSearchService
1107
1254
  req.send_request(options)
1108
1255
  end
1109
1256
 
1110
- # 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
1111
1263
  #
1112
1264
  # @option params [required, String] :package_id
1113
1265
  # The internal ID of the package you want to delete. Use
@@ -1145,11 +1297,43 @@ module Aws::OpenSearchService
1145
1297
  req.send_request(options)
1146
1298
  end
1147
1299
 
1148
- # Returns domain configuration information about the specified domain,
1149
- # 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.
1150
1334
  #
1151
1335
  # @option params [required, String] :domain_name
1152
- # The name of the domain for which you want information.
1336
+ # The name of the domain that you want information about.
1153
1337
  #
1154
1338
  # @return [Types::DescribeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1155
1339
  #
@@ -1248,19 +1432,26 @@ module Aws::OpenSearchService
1248
1432
  req.send_request(options)
1249
1433
  end
1250
1434
 
1251
- # Provides scheduled Auto-Tune action details for the domain, such as
1252
- # 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
1253
1442
  #
1254
1443
  # @option params [required, String] :domain_name
1255
- # The domain name for which you want Auto-Tune action details.
1444
+ # Name of the domain that you want Auto-Tune details about.
1256
1445
  #
1257
1446
  # @option params [Integer] :max_results
1258
- # Set this value to limit the number of results returned. If not
1259
- # 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.
1260
1449
  #
1261
1450
  # @option params [String] :next_token
1262
- # NextToken is sent in case the earlier API call results contain the
1263
- # 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.
1264
1455
  #
1265
1456
  # @return [Types::DescribeDomainAutoTunesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1266
1457
  #
@@ -1297,15 +1488,20 @@ module Aws::OpenSearchService
1297
1488
  end
1298
1489
 
1299
1490
  # Returns information about the current blue/green deployment happening
1300
- # 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
1301
1497
  #
1302
1498
  # @option params [required, String] :domain_name
1303
- # The domain you want to get the progress information about.
1499
+ # The name of the domain to get progress information for.
1304
1500
  #
1305
1501
  # @option params [String] :change_id
1306
1502
  # The specific change ID for which you want to get progress information.
1307
- # This is an optional parameter. If omitted, the service returns
1308
- # information about the most recent configuration change.
1503
+ # If omitted, the request returns information about the most recent
1504
+ # configuration change.
1309
1505
  #
1310
1506
  # @return [Types::DescribeDomainChangeProgressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1311
1507
  #
@@ -1343,12 +1539,11 @@ module Aws::OpenSearchService
1343
1539
  req.send_request(options)
1344
1540
  end
1345
1541
 
1346
- # Provides cluster configuration information about the specified domain,
1347
- # such as the state, creation date, update version, and update date for
1348
- # cluster options.
1542
+ # Returns the configuration of an Amazon OpenSearch Service domain.
1349
1543
  #
1350
1544
  # @option params [required, String] :domain_name
1351
- # The domain you want to get information about.
1545
+ # Name of the OpenSearch Service domain configuration that you want to
1546
+ # describe.
1352
1547
  #
1353
1548
  # @return [Types::DescribeDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1354
1549
  #
@@ -1505,11 +1700,13 @@ module Aws::OpenSearchService
1505
1700
  req.send_request(options)
1506
1701
  end
1507
1702
 
1508
- # Returns domain configuration information about the specified domains,
1509
- # including the domain ID, domain endpoint, and domain ARN.
1703
+ # Returns domain configuration information about the specified Amazon
1704
+ # OpenSearch Service domains.
1510
1705
  #
1511
1706
  # @option params [required, Array<String>] :domain_names
1512
- # 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.
1513
1710
  #
1514
1711
  # @return [Types::DescribeDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1515
1712
  #
@@ -1609,24 +1806,28 @@ module Aws::OpenSearchService
1609
1806
  req.send_request(options)
1610
1807
  end
1611
1808
 
1612
- # 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
1613
1817
  #
1614
1818
  # @option params [Array<Types::Filter>] :filters
1615
1819
  # A list of filters used to match properties for inbound cross-cluster
1616
- # connections. Available ` Filter ` values are: * connection-id
1617
- # * local-domain-info.domain-name
1618
- # * local-domain-info.owner-id
1619
- # * local-domain-info.region
1620
- # * remote-domain-info.domain-name
1820
+ # connections.
1621
1821
  #
1622
1822
  # @option params [Integer] :max_results
1623
- # Set this value to limit the number of results returned. If not
1624
- # 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.
1625
1825
  #
1626
1826
  # @option params [String] :next_token
1627
- # If more results are available and NextToken is present, make the next
1628
- # request to the same API with the received NextToken to paginate the
1629
- # 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.
1630
1831
  #
1631
1832
  # @return [Types::DescribeInboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
1833
  #
@@ -1671,20 +1872,21 @@ module Aws::OpenSearchService
1671
1872
  req.send_request(options)
1672
1873
  end
1673
1874
 
1674
- # Describe the limits for a given instance type and OpenSearch or
1675
- # Elasticsearch version. When modifying an existing domain, specify the
1676
- # ` 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.
1677
1877
  #
1678
1878
  # @option params [String] :domain_name
1679
- # The name of the domain you want to modify. Only include this value if
1680
- # 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.
1681
1881
  #
1682
1882
  # @option params [required, String] :instance_type
1683
- # The instance type for an OpenSearch cluster for which OpenSearch `
1684
- # Limits ` are needed.
1883
+ # The OpenSearch Service instance type for which you need limit
1884
+ # information.
1685
1885
  #
1686
1886
  # @option params [required, String] :engine_version
1687
- # 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.
1688
1890
  #
1689
1891
  # @return [Types::DescribeInstanceTypeLimitsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1690
1892
  #
@@ -1724,24 +1926,26 @@ module Aws::OpenSearchService
1724
1926
  req.send_request(options)
1725
1927
  end
1726
1928
 
1727
- # 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
1728
1936
  #
1729
1937
  # @option params [Array<Types::Filter>] :filters
1730
- # A list of filters used to match properties for outbound cross-cluster
1731
- # connections. Available ` Filter ` names for this operation are: *
1732
- # connection-id
1733
- # * remote-domain-info.domain-name
1734
- # * remote-domain-info.owner-id
1735
- # * remote-domain-info.region
1736
- # * local-domain-info.domain-name
1938
+ # List of filter names and values that you can use for requests.
1737
1939
  #
1738
1940
  # @option params [Integer] :max_results
1739
- # Set this value to limit the number of results returned. If not
1740
- # 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.
1741
1943
  #
1742
1944
  # @option params [String] :next_token
1743
- # NextToken is sent in case the earlier API call results contain the
1744
- # 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.
1745
1949
  #
1746
1950
  # @return [Types::DescribeOutboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1747
1951
  #
@@ -1787,20 +1991,25 @@ module Aws::OpenSearchService
1787
1991
  req.send_request(options)
1788
1992
  end
1789
1993
 
1790
- # Describes all packages available to Amazon OpenSearch Service domains.
1791
- # Includes options for filtering, limiting the number of results, and
1792
- # 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
1793
2000
  #
1794
2001
  # @option params [Array<Types::DescribePackagesFilter>] :filters
1795
2002
  # Only returns packages that match the `DescribePackagesFilterList`
1796
2003
  # values.
1797
2004
  #
1798
2005
  # @option params [Integer] :max_results
1799
- # 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.
1800
2008
  #
1801
2009
  # @option params [String] :next_token
1802
- # Used for pagination. Only necessary if a previous API call includes a
1803
- # 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
1804
2013
  # page.
1805
2014
  #
1806
2015
  # @return [Types::DescribePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1847,19 +2056,28 @@ module Aws::OpenSearchService
1847
2056
  req.send_request(options)
1848
2057
  end
1849
2058
 
1850
- # 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
1851
2066
  #
1852
2067
  # @option params [String] :reserved_instance_offering_id
1853
- # The offering identifier filter value. Use this parameter to show only
1854
- # the available offering that matches the specified reservation
1855
- # 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.
1856
2071
  #
1857
2072
  # @option params [Integer] :max_results
1858
- # Set this value to limit the number of results returned. If not
1859
- # 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.
1860
2075
  #
1861
2076
  # @option params [String] :next_token
1862
- # 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.
1863
2081
  #
1864
2082
  # @return [Types::DescribeReservedInstanceOfferingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1865
2083
  #
@@ -1900,8 +2118,13 @@ module Aws::OpenSearchService
1900
2118
  req.send_request(options)
1901
2119
  end
1902
2120
 
1903
- # Returns information about reserved OpenSearch instances for this
1904
- # 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
1905
2128
  #
1906
2129
  # @option params [String] :reserved_instance_id
1907
2130
  # The reserved instance identifier filter value. Use this parameter to
@@ -1909,11 +2132,14 @@ module Aws::OpenSearchService
1909
2132
  # OpenSearch instance ID.
1910
2133
  #
1911
2134
  # @option params [Integer] :max_results
1912
- # Set this value to limit the number of results returned. If not
1913
- # 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.
1914
2137
  #
1915
2138
  # @option params [String] :next_token
1916
- # 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.
1917
2143
  #
1918
2144
  # @return [Types::DescribeReservedInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1919
2145
  #
@@ -1960,14 +2186,67 @@ module Aws::OpenSearchService
1960
2186
  req.send_request(options)
1961
2187
  end
1962
2188
 
1963
- # 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
1964
2243
  #
1965
2244
  # @option params [required, String] :package_id
1966
- # The internal ID of the package to associate with a domain. Use
1967
- # `DescribePackages` to find this value.
2245
+ # Internal ID of the package to dissociate from the domain. Use
2246
+ # `ListPackagesForDomain` to find this value.
1968
2247
  #
1969
2248
  # @option params [required, String] :domain_name
1970
- # The name of the domain to associate the package with.
2249
+ # Name of the domain to dissociate the package from.
1971
2250
  #
1972
2251
  # @return [Types::DissociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1973
2252
  #
@@ -2002,16 +2281,12 @@ module Aws::OpenSearchService
2002
2281
  req.send_request(options)
2003
2282
  end
2004
2283
 
2005
- # Returns a list of upgrade-compatible versions of
2006
- # OpenSearch/Elasticsearch. You can optionally pass a ` DomainName ` to
2007
- # get all upgrade-compatible versions of OpenSearch/Elasticsearch for
2008
- # that specific domain.
2284
+ # Returns a map of OpenSearch or Elasticsearch versions and the versions
2285
+ # you can upgrade them to.
2009
2286
  #
2010
2287
  # @option params [String] :domain_name
2011
- # The name of an domain. Domain names are unique across the domains
2012
- # owned by an account within an AWS region. Domain names start with a
2013
- # letter or number and can contain the following characters: a-z
2014
- # (lowercase), 0-9, and - (hyphen).
2288
+ # The name of an existing domain. Provide this parameter to limit the
2289
+ # results to a single domain.
2015
2290
  #
2016
2291
  # @return [Types::GetCompatibleVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2017
2292
  #
@@ -2039,19 +2314,26 @@ module Aws::OpenSearchService
2039
2314
  req.send_request(options)
2040
2315
  end
2041
2316
 
2042
- # Returns a list of package versions, along with their creation time and
2043
- # 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
2044
2324
  #
2045
2325
  # @option params [required, String] :package_id
2046
- # Returns an audit history of package versions.
2326
+ # The unique identifier of the package.
2047
2327
  #
2048
2328
  # @option params [Integer] :max_results
2049
- # 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.
2050
2331
  #
2051
2332
  # @option params [String] :next_token
2052
- # Used for pagination. Only necessary if a previous API call includes a
2053
- # non-null NextToken value. If provided, returns results for the next
2054
- # 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.
2055
2337
  #
2056
2338
  # @return [Types::GetPackageVersionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2057
2339
  #
@@ -2087,22 +2369,21 @@ module Aws::OpenSearchService
2087
2369
  req.send_request(options)
2088
2370
  end
2089
2371
 
2090
- # Retrieves the complete history of the last 10 upgrades performed on
2091
- # the domain.
2372
+ # Retrieves the complete history of the last 10 upgrades performed on an
2373
+ # Amazon OpenSearch Service domain.
2092
2374
  #
2093
2375
  # @option params [required, String] :domain_name
2094
- # The name of an domain. Domain names are unique across the domains
2095
- # owned by an account within an AWS region. Domain names start with a
2096
- # letter or number and can contain the following characters: a-z
2097
- # (lowercase), 0-9, and - (hyphen).
2376
+ # The name of an existing domain.
2098
2377
  #
2099
2378
  # @option params [Integer] :max_results
2100
- # 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.
2101
2381
  #
2102
2382
  # @option params [String] :next_token
2103
- # Paginated APIs accept the NextToken input to return the next page of
2104
- # results and provide a NextToken output in the response, which you can
2105
- # 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.
2106
2387
  #
2107
2388
  # @return [Types::GetUpgradeHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2108
2389
  #
@@ -2142,14 +2423,11 @@ module Aws::OpenSearchService
2142
2423
  req.send_request(options)
2143
2424
  end
2144
2425
 
2145
- # Retrieves the latest status of the last upgrade or upgrade eligibility
2146
- # 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.
2147
2428
  #
2148
2429
  # @option params [required, String] :domain_name
2149
- # The name of an domain. Domain names are unique across the domains
2150
- # owned by an account within an AWS region. Domain names start with a
2151
- # letter or number and can contain the following characters: a-z
2152
- # (lowercase), 0-9, and - (hyphen).
2430
+ # The domain of the domain to get upgrade status information for.
2153
2431
  #
2154
2432
  # @return [Types::GetUpgradeStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2155
2433
  #
@@ -2178,11 +2456,11 @@ module Aws::OpenSearchService
2178
2456
  req.send_request(options)
2179
2457
  end
2180
2458
 
2181
- # 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.
2182
2461
  #
2183
2462
  # @option params [String] :engine_type
2184
- # Optional parameter to filter the output by domain engine type.
2185
- # Acceptable values are 'Elasticsearch' and 'OpenSearch'.
2463
+ # Filters the output by domain engine type.
2186
2464
  #
2187
2465
  # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2188
2466
  #
@@ -2209,18 +2487,26 @@ module Aws::OpenSearchService
2209
2487
  req.send_request(options)
2210
2488
  end
2211
2489
 
2212
- # Lists all Amazon OpenSearch Service domains associated with the
2213
- # 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
2214
2497
  #
2215
2498
  # @option params [required, String] :package_id
2216
- # The package for which to list associated domains.
2499
+ # The unique identifier of the package for which to list associated
2500
+ # domains.
2217
2501
  #
2218
2502
  # @option params [Integer] :max_results
2219
- # 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.
2220
2505
  #
2221
2506
  # @option params [String] :next_token
2222
- # Used for pagination. Only necessary if a previous API call includes a
2223
- # 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
2224
2510
  # page.
2225
2511
  #
2226
2512
  # @return [Types::ListDomainsForPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2262,21 +2548,26 @@ module Aws::OpenSearchService
2262
2548
  req.send_request(options)
2263
2549
  end
2264
2550
 
2551
+ # Lists all instance types and available features for a given OpenSearch
2552
+ # or Elasticsearch version.
2553
+ #
2265
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.
2266
2558
  #
2267
2559
  # @option params [String] :domain_name
2268
- # The name of an domain. Domain names are unique across the domains
2269
- # owned by an account within an AWS region. Domain names start with a
2270
- # letter or number and can contain the following characters: a-z
2271
- # (lowercase), 0-9, and - (hyphen).
2560
+ # Name of the domain to list instance type details for.
2272
2561
  #
2273
2562
  # @option params [Integer] :max_results
2274
- # 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.
2275
2565
  #
2276
2566
  # @option params [String] :next_token
2277
- # Paginated APIs accept the NextToken input to return the next page of
2278
- # results and provide a NextToken output in the response, which you can
2279
- # 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.
2280
2571
  #
2281
2572
  # @return [Types::ListInstanceTypeDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2282
2573
  #
@@ -2316,18 +2607,25 @@ module Aws::OpenSearchService
2316
2607
  req.send_request(options)
2317
2608
  end
2318
2609
 
2319
- # Lists all packages associated with the Amazon OpenSearch Service
2320
- # 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
2321
2617
  #
2322
2618
  # @option params [required, String] :domain_name
2323
2619
  # The name of the domain for which you want to list associated packages.
2324
2620
  #
2325
2621
  # @option params [Integer] :max_results
2326
- # 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.
2327
2624
  #
2328
2625
  # @option params [String] :next_token
2329
- # Used for pagination. Only necessary if a previous API call includes a
2330
- # 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
2331
2629
  # page.
2332
2630
  #
2333
2631
  # @return [Types::ListPackagesForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2369,11 +2667,15 @@ module Aws::OpenSearchService
2369
2667
  req.send_request(options)
2370
2668
  end
2371
2669
 
2372
- # 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
2373
2676
  #
2374
2677
  # @option params [required, String] :arn
2375
- # Specify the `ARN` of the domain that the tags you want to view are
2376
- # attached to.
2678
+ # Amazon Resource Name (ARN) for the domain to view tags for.
2377
2679
  #
2378
2680
  # @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2379
2681
  #
@@ -2400,16 +2702,17 @@ module Aws::OpenSearchService
2400
2702
  req.send_request(options)
2401
2703
  end
2402
2704
 
2403
- # List all supported versions of OpenSearch and Elasticsearch.
2705
+ # Lists all versions of OpenSearch and Elasticsearch that Amazon
2706
+ # OpenSearch Service supports.
2404
2707
  #
2405
2708
  # @option params [Integer] :max_results
2406
- # Set this value to limit the number of results returned. Value must be
2407
- # 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.
2408
2711
  #
2409
2712
  # @option params [String] :next_token
2410
- # Paginated APIs accept the NextToken input to return the next page of
2411
- # results and provide a NextToken output in the response, which you can
2412
- # 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.
2413
2716
  #
2414
2717
  # @return [Types::ListVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2415
2718
  #
@@ -2440,10 +2743,131 @@ module Aws::OpenSearchService
2440
2743
  req.send_request(options)
2441
2744
  end
2442
2745
 
2443
- # 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.
2444
2868
  #
2445
2869
  # @option params [required, String] :reserved_instance_offering_id
2446
- # The ID of the reserved OpenSearch instance offering to purchase.
2870
+ # The ID of the Reserved Instance offering to purchase.
2447
2871
  #
2448
2872
  # @option params [required, String] :reservation_name
2449
2873
  # A customer-specified identifier to track this reservation.
@@ -2478,11 +2902,11 @@ module Aws::OpenSearchService
2478
2902
  req.send_request(options)
2479
2903
  end
2480
2904
 
2481
- # Allows the remote domain owner to reject an inbound cross-cluster
2482
- # connection request.
2905
+ # Allows the remote Amazon OpenSearch Service domain owner to reject an
2906
+ # inbound cross-cluster connection request.
2483
2907
  #
2484
2908
  # @option params [required, String] :connection_id
2485
- # The ID of the inbound connection to reject.
2909
+ # The unique identifier of the inbound connection to reject.
2486
2910
  #
2487
2911
  # @return [Types::RejectInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2488
2912
  #
@@ -2515,14 +2939,20 @@ module Aws::OpenSearchService
2515
2939
  req.send_request(options)
2516
2940
  end
2517
2941
 
2518
- # 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
2519
2949
  #
2520
2950
  # @option params [required, String] :arn
2521
- # The `ARN` of the domain from which you want to delete the specified
2522
- # tags.
2951
+ # The Amazon Resource Name (ARN) of the domain from which you want to
2952
+ # delete the specified tags.
2523
2953
  #
2524
2954
  # @option params [required, Array<String>] :tag_keys
2525
- # The `TagKey` list you want to remove from the domain.
2955
+ # The list of tag keys to remove from the domain.
2526
2956
  #
2527
2957
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2528
2958
  #
@@ -2542,8 +2972,40 @@ module Aws::OpenSearchService
2542
2972
  req.send_request(options)
2543
2973
  end
2544
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
+
2545
3002
  # Schedules a service software update for an Amazon OpenSearch Service
2546
- # 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
2547
3009
  #
2548
3010
  # @option params [required, String] :domain_name
2549
3011
  # The name of the domain that you want to update to the latest service
@@ -2579,78 +3041,97 @@ module Aws::OpenSearchService
2579
3041
  req.send_request(options)
2580
3042
  end
2581
3043
 
2582
- # Modifies the cluster configuration of the specified domain, such as
2583
- # setting the instance type and the number of instances.
3044
+ # Modifies the cluster configuration of the specified Amazon OpenSearch
3045
+ # Service domain.
2584
3046
  #
2585
3047
  # @option params [required, String] :domain_name
2586
- # The name of the domain you're updating.
3048
+ # The name of the domain that you're updating.
2587
3049
  #
2588
3050
  # @option params [Types::ClusterConfig] :cluster_config
2589
- # The type and number of instances to instantiate for the domain
2590
- # cluster.
3051
+ # Changes that you want to make to the cluster configuration, such as
3052
+ # the instance type and number of EC2 instances.
2591
3053
  #
2592
3054
  # @option params [Types::EBSOptions] :ebs_options
2593
- # 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.
2594
3057
  #
2595
3058
  # @option params [Types::SnapshotOptions] :snapshot_options
2596
3059
  # Option to set the time, in UTC format, for the daily automated
2597
3060
  # snapshot. Default value is `0` hours.
2598
3061
  #
2599
3062
  # @option params [Types::VPCOptions] :vpc_options
2600
- # Options to specify the subnets and security groups for the VPC
2601
- # endpoint. For more information, see [Launching your Amazon OpenSearch
2602
- # 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].
2603
3066
  #
2604
3067
  #
2605
3068
  #
2606
- # [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
2607
3070
  #
2608
3071
  # @option params [Types::CognitoOptions] :cognito_options
2609
- # Options to specify the Cognito user and identity pools for OpenSearch
2610
- # Dashboards authentication. For more information, see [Configuring
2611
- # Amazon Cognito authentication for OpenSearch Dashboards][1].
3072
+ # Key-value pairs to configure Amazon Cognito authentication for
3073
+ # OpenSearch Dashboards.
2612
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:
2613
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.
2614
3085
  #
2615
- # [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.
2616
3089
  #
2617
- # @option params [Hash<String,String>] :advanced_options
2618
- # Modifies the advanced option to allow references to indices in an HTTP
2619
- # request body. Must be `false` when configuring access to individual
2620
- # sub-resources. By default, the value is `true`. See [Advanced options
2621
- # ][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.
2622
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.
2623
3101
  #
3102
+ # For more information, see [Advanced cluster parameters][1].
2624
3103
  #
2625
- # [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
2626
3107
  #
2627
3108
  # @option params [String] :access_policies
2628
- # IAM access policy as a JSON-formatted string.
3109
+ # Identity and Access Management (IAM) access policy as a JSON-formatted
3110
+ # string.
2629
3111
  #
2630
3112
  # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
2631
- # Map of `LogType` and `LogPublishingOption`, each containing options to
2632
- # publish a given type of OpenSearch log.
3113
+ # Options to publish OpenSearch lots to Amazon CloudWatch Logs.
2633
3114
  #
2634
3115
  # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
2635
- # Specifies encryption of data at rest options.
3116
+ # Encryption at rest options for the domain.
2636
3117
  #
2637
3118
  # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
2638
- # Options to specify configuration that will be applied to the domain
2639
- # endpoint.
3119
+ # Additional options for the domain endpoint, such as whether to require
3120
+ # HTTPS for all traffic.
2640
3121
  #
2641
3122
  # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
2642
- # Specifies node-to-node encryption options.
3123
+ # Node-To-Node Encryption options for the domain.
2643
3124
  #
2644
3125
  # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
2645
- # Specifies advanced security options.
3126
+ # Options for fine-grained access control.
2646
3127
  #
2647
3128
  # @option params [Types::AutoTuneOptions] :auto_tune_options
2648
- # Specifies Auto-Tune options.
3129
+ # Options for Auto-Tune.
2649
3130
  #
2650
3131
  # @option params [Boolean] :dry_run
2651
3132
  # This flag, when set to True, specifies whether the `UpdateDomain`
2652
- # request should return the results of validation checks (DryRunResults)
2653
- # without actually applying the change.
3133
+ # request should return the results of validation check without actually
3134
+ # applying the change.
2654
3135
  #
2655
3136
  # @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2656
3137
  #
@@ -2908,20 +3389,25 @@ module Aws::OpenSearchService
2908
3389
  req.send_request(options)
2909
3390
  end
2910
3391
 
2911
- # 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
2912
3399
  #
2913
3400
  # @option params [required, String] :package_id
2914
3401
  # The unique identifier for the package.
2915
3402
  #
2916
3403
  # @option params [required, Types::PackageSource] :package_source
2917
- # The Amazon S3 location for importing the package specified as
2918
- # `S3BucketName` and `S3Key`
3404
+ # Amazon S3 bucket and key for the package.
2919
3405
  #
2920
3406
  # @option params [String] :package_description
2921
3407
  # A new description of the package.
2922
3408
  #
2923
3409
  # @option params [String] :commit_message
2924
- # 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
2925
3411
  # `GetPackageVersionHistoryResponse`.
2926
3412
  #
2927
3413
  # @return [Types::UpdatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2962,40 +3448,73 @@ module Aws::OpenSearchService
2962
3448
  req.send_request(options)
2963
3449
  end
2964
3450
 
2965
- # Allows you to either upgrade your domain or perform an upgrade
2966
- # eligibility check to a compatible version of OpenSearch or
2967
- # 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.
2968
3500
  #
2969
3501
  # @option params [required, String] :domain_name
2970
- # The name of an domain. Domain names are unique across the domains
2971
- # owned by an account within an AWS region. Domain names start with a
2972
- # letter or number and can contain the following characters: a-z
2973
- # (lowercase), 0-9, and - (hyphen).
3502
+ # Name of the OpenSearch Service domain that you want to upgrade.
2974
3503
  #
2975
3504
  # @option params [required, String] :target_version
2976
- # 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.
2977
3507
  #
2978
3508
  # @option params [Boolean] :perform_check_only
2979
3509
  # When true, indicates that an upgrade eligibility check needs to be
2980
3510
  # performed. Does not actually perform the upgrade.
2981
3511
  #
2982
3512
  # @option params [Hash<String,String>] :advanced_options
2983
- # Exposes select native OpenSearch configuration values from
2984
- # `opensearch.yml`. Currently, the following advanced options are
2985
- # available:
2986
- #
2987
- # * Option to allow references to indices in an HTTP request body. Must
2988
- # be `false` when configuring access to individual sub-resources. By
2989
- # default, the value is `true`. See [Advanced cluster parameters ][1]
2990
- # for more information.
2991
- # * Option to specify the percentage of heap space allocated to field
2992
- # data. By default, this setting is unbounded.
2993
- #
2994
- # For more information, see [ Advanced cluster parameters][1].
2995
- #
2996
- #
2997
- #
2998
- # [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.
2999
3518
  #
3000
3519
  # @return [Types::UpgradeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3001
3520
  #
@@ -3050,7 +3569,7 @@ module Aws::OpenSearchService
3050
3569
  params: params,
3051
3570
  config: config)
3052
3571
  context[:gem_name] = 'aws-sdk-opensearchservice'
3053
- context[:gem_version] = '1.12.0'
3572
+ context[:gem_version] = '1.13.0'
3054
3573
  Seahorse::Client::Request.new(handlers, context)
3055
3574
  end
3056
3575