aws-sdk-opensearchserverless 1.32.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchserverless/client.rb +440 -435
- data/lib/aws-sdk-opensearchserverless/client_api.rb +157 -155
- data/lib/aws-sdk-opensearchserverless/endpoint_provider.rb +13 -17
- data/lib/aws-sdk-opensearchserverless/errors.rb +5 -5
- data/lib/aws-sdk-opensearchserverless/types.rb +767 -761
- data/lib/aws-sdk-opensearchserverless/waiters.rb +15 -0
- data/lib/aws-sdk-opensearchserverless.rb +2 -1
- data/sig/client.rbs +98 -96
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +156 -155
- metadata +3 -2
@@ -514,25 +514,25 @@ module Aws::OpenSearchServerless
|
|
514
514
|
# @example Response structure
|
515
515
|
#
|
516
516
|
# resp.collection_details #=> Array
|
517
|
+
# resp.collection_details[0].id #=> String
|
518
|
+
# resp.collection_details[0].name #=> String
|
519
|
+
# resp.collection_details[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
|
520
|
+
# resp.collection_details[0].type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
|
521
|
+
# resp.collection_details[0].description #=> String
|
517
522
|
# resp.collection_details[0].arn #=> String
|
518
|
-
# resp.collection_details[0].
|
523
|
+
# resp.collection_details[0].kms_key_arn #=> String
|
524
|
+
# resp.collection_details[0].standby_replicas #=> String, one of "ENABLED", "DISABLED"
|
519
525
|
# resp.collection_details[0].created_date #=> Integer
|
526
|
+
# resp.collection_details[0].last_modified_date #=> Integer
|
527
|
+
# resp.collection_details[0].collection_endpoint #=> String
|
520
528
|
# resp.collection_details[0].dashboard_endpoint #=> String
|
521
|
-
# resp.collection_details[0].description #=> String
|
522
529
|
# resp.collection_details[0].failure_code #=> String
|
523
530
|
# resp.collection_details[0].failure_message #=> String
|
524
|
-
# resp.collection_details[0].id #=> String
|
525
|
-
# resp.collection_details[0].kms_key_arn #=> String
|
526
|
-
# resp.collection_details[0].last_modified_date #=> Integer
|
527
|
-
# resp.collection_details[0].name #=> String
|
528
|
-
# resp.collection_details[0].standby_replicas #=> String, one of "ENABLED", "DISABLED"
|
529
|
-
# resp.collection_details[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
|
530
|
-
# resp.collection_details[0].type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
|
531
531
|
# resp.collection_error_details #=> Array
|
532
|
-
# resp.collection_error_details[0].error_code #=> String
|
533
|
-
# resp.collection_error_details[0].error_message #=> String
|
534
532
|
# resp.collection_error_details[0].id #=> String
|
535
533
|
# resp.collection_error_details[0].name #=> String
|
534
|
+
# resp.collection_error_details[0].error_message #=> String
|
535
|
+
# resp.collection_error_details[0].error_code #=> String
|
536
536
|
#
|
537
537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetCollection AWS API Documentation
|
538
538
|
#
|
@@ -564,8 +564,8 @@ module Aws::OpenSearchServerless
|
|
564
564
|
# resp = client.batch_get_effective_lifecycle_policy({
|
565
565
|
# resource_identifiers: [ # required
|
566
566
|
# {
|
567
|
-
# resource: "ResourceName", # required
|
568
567
|
# type: "retention", # required, accepts retention
|
568
|
+
# resource: "ResourceName", # required
|
569
569
|
# },
|
570
570
|
# ],
|
571
571
|
# })
|
@@ -573,17 +573,17 @@ module Aws::OpenSearchServerless
|
|
573
573
|
# @example Response structure
|
574
574
|
#
|
575
575
|
# resp.effective_lifecycle_policy_details #=> Array
|
576
|
-
# resp.effective_lifecycle_policy_details[0].
|
577
|
-
# resp.effective_lifecycle_policy_details[0].policy_name #=> String
|
576
|
+
# resp.effective_lifecycle_policy_details[0].type #=> String, one of "retention"
|
578
577
|
# resp.effective_lifecycle_policy_details[0].resource #=> String
|
578
|
+
# resp.effective_lifecycle_policy_details[0].policy_name #=> String
|
579
579
|
# resp.effective_lifecycle_policy_details[0].resource_type #=> String, one of "index"
|
580
580
|
# resp.effective_lifecycle_policy_details[0].retention_period #=> String
|
581
|
-
# resp.effective_lifecycle_policy_details[0].
|
581
|
+
# resp.effective_lifecycle_policy_details[0].no_min_retention_period #=> Boolean
|
582
582
|
# resp.effective_lifecycle_policy_error_details #=> Array
|
583
|
-
# resp.effective_lifecycle_policy_error_details[0].error_code #=> String
|
584
|
-
# resp.effective_lifecycle_policy_error_details[0].error_message #=> String
|
585
|
-
# resp.effective_lifecycle_policy_error_details[0].resource #=> String
|
586
583
|
# resp.effective_lifecycle_policy_error_details[0].type #=> String, one of "retention"
|
584
|
+
# resp.effective_lifecycle_policy_error_details[0].resource #=> String
|
585
|
+
# resp.effective_lifecycle_policy_error_details[0].error_message #=> String
|
586
|
+
# resp.effective_lifecycle_policy_error_details[0].error_code #=> String
|
587
587
|
#
|
588
588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetEffectiveLifecyclePolicy AWS API Documentation
|
589
589
|
#
|
@@ -615,8 +615,8 @@ module Aws::OpenSearchServerless
|
|
615
615
|
# resp = client.batch_get_lifecycle_policy({
|
616
616
|
# identifiers: [ # required
|
617
617
|
# {
|
618
|
-
# name: "PolicyName", # required
|
619
618
|
# type: "retention", # required, accepts retention
|
619
|
+
# name: "PolicyName", # required
|
620
620
|
# },
|
621
621
|
# ],
|
622
622
|
# })
|
@@ -624,17 +624,17 @@ module Aws::OpenSearchServerless
|
|
624
624
|
# @example Response structure
|
625
625
|
#
|
626
626
|
# resp.lifecycle_policy_details #=> Array
|
627
|
-
# resp.lifecycle_policy_details[0].
|
628
|
-
# resp.lifecycle_policy_details[0].description #=> String
|
629
|
-
# resp.lifecycle_policy_details[0].last_modified_date #=> Integer
|
627
|
+
# resp.lifecycle_policy_details[0].type #=> String, one of "retention"
|
630
628
|
# resp.lifecycle_policy_details[0].name #=> String
|
631
629
|
# resp.lifecycle_policy_details[0].policy_version #=> String
|
632
|
-
# resp.lifecycle_policy_details[0].
|
630
|
+
# resp.lifecycle_policy_details[0].description #=> String
|
631
|
+
# resp.lifecycle_policy_details[0].created_date #=> Integer
|
632
|
+
# resp.lifecycle_policy_details[0].last_modified_date #=> Integer
|
633
633
|
# resp.lifecycle_policy_error_details #=> Array
|
634
|
-
# resp.lifecycle_policy_error_details[0].error_code #=> String
|
635
|
-
# resp.lifecycle_policy_error_details[0].error_message #=> String
|
636
|
-
# resp.lifecycle_policy_error_details[0].name #=> String
|
637
634
|
# resp.lifecycle_policy_error_details[0].type #=> String, one of "retention"
|
635
|
+
# resp.lifecycle_policy_error_details[0].name #=> String
|
636
|
+
# resp.lifecycle_policy_error_details[0].error_message #=> String
|
637
|
+
# resp.lifecycle_policy_error_details[0].error_code #=> String
|
638
638
|
#
|
639
639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetLifecyclePolicy AWS API Documentation
|
640
640
|
#
|
@@ -670,21 +670,21 @@ module Aws::OpenSearchServerless
|
|
670
670
|
# @example Response structure
|
671
671
|
#
|
672
672
|
# resp.vpc_endpoint_details #=> Array
|
673
|
-
# resp.vpc_endpoint_details[0].created_date #=> Integer
|
674
|
-
# resp.vpc_endpoint_details[0].failure_code #=> String
|
675
|
-
# resp.vpc_endpoint_details[0].failure_message #=> String
|
676
673
|
# resp.vpc_endpoint_details[0].id #=> String
|
677
674
|
# resp.vpc_endpoint_details[0].name #=> String
|
675
|
+
# resp.vpc_endpoint_details[0].vpc_id #=> String
|
676
|
+
# resp.vpc_endpoint_details[0].subnet_ids #=> Array
|
677
|
+
# resp.vpc_endpoint_details[0].subnet_ids[0] #=> String
|
678
678
|
# resp.vpc_endpoint_details[0].security_group_ids #=> Array
|
679
679
|
# resp.vpc_endpoint_details[0].security_group_ids[0] #=> String
|
680
680
|
# resp.vpc_endpoint_details[0].status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"
|
681
|
-
# resp.vpc_endpoint_details[0].
|
682
|
-
# resp.vpc_endpoint_details[0].
|
683
|
-
# resp.vpc_endpoint_details[0].
|
681
|
+
# resp.vpc_endpoint_details[0].created_date #=> Integer
|
682
|
+
# resp.vpc_endpoint_details[0].failure_code #=> String
|
683
|
+
# resp.vpc_endpoint_details[0].failure_message #=> String
|
684
684
|
# resp.vpc_endpoint_error_details #=> Array
|
685
|
-
# resp.vpc_endpoint_error_details[0].error_code #=> String
|
686
|
-
# resp.vpc_endpoint_error_details[0].error_message #=> String
|
687
685
|
# resp.vpc_endpoint_error_details[0].id #=> String
|
686
|
+
# resp.vpc_endpoint_error_details[0].error_message #=> String
|
687
|
+
# resp.vpc_endpoint_error_details[0].error_code #=> String
|
688
688
|
#
|
689
689
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetVpcEndpoint AWS API Documentation
|
690
690
|
#
|
@@ -705,25 +705,25 @@ module Aws::OpenSearchServerless
|
|
705
705
|
#
|
706
706
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
707
707
|
#
|
708
|
-
# @option params [String] :
|
709
|
-
#
|
710
|
-
# request.
|
708
|
+
# @option params [required, String] :type
|
709
|
+
# The type of policy.
|
711
710
|
#
|
712
|
-
#
|
713
|
-
#
|
711
|
+
# @option params [required, String] :name
|
712
|
+
# The name of the policy.
|
714
713
|
#
|
715
714
|
# @option params [String] :description
|
716
715
|
# A description of the policy. Typically used to store information about
|
717
716
|
# the permissions defined in the policy.
|
718
717
|
#
|
719
|
-
# @option params [required, String] :name
|
720
|
-
# The name of the policy.
|
721
|
-
#
|
722
718
|
# @option params [required, String] :policy
|
723
719
|
# The JSON policy document to use as the content for the policy.
|
724
720
|
#
|
725
|
-
# @option params [
|
726
|
-
#
|
721
|
+
# @option params [String] :client_token
|
722
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
723
|
+
# request.
|
724
|
+
#
|
725
|
+
# **A suitable default value is auto-generated.** You should normally
|
726
|
+
# not need to pass this option.**
|
727
727
|
#
|
728
728
|
# @return [Types::CreateAccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
729
729
|
#
|
@@ -732,21 +732,21 @@ module Aws::OpenSearchServerless
|
|
732
732
|
# @example Request syntax with placeholder values
|
733
733
|
#
|
734
734
|
# resp = client.create_access_policy({
|
735
|
-
#
|
736
|
-
# description: "PolicyDescription",
|
735
|
+
# type: "data", # required, accepts data
|
737
736
|
# name: "PolicyName", # required
|
737
|
+
# description: "PolicyDescription",
|
738
738
|
# policy: "PolicyDocument", # required
|
739
|
-
#
|
739
|
+
# client_token: "ClientToken",
|
740
740
|
# })
|
741
741
|
#
|
742
742
|
# @example Response structure
|
743
743
|
#
|
744
|
-
# resp.access_policy_detail.
|
745
|
-
# resp.access_policy_detail.description #=> String
|
746
|
-
# resp.access_policy_detail.last_modified_date #=> Integer
|
744
|
+
# resp.access_policy_detail.type #=> String, one of "data"
|
747
745
|
# resp.access_policy_detail.name #=> String
|
748
746
|
# resp.access_policy_detail.policy_version #=> String
|
749
|
-
# resp.access_policy_detail.
|
747
|
+
# resp.access_policy_detail.description #=> String
|
748
|
+
# resp.access_policy_detail.created_date #=> Integer
|
749
|
+
# resp.access_policy_detail.last_modified_date #=> Integer
|
750
750
|
#
|
751
751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateAccessPolicy AWS API Documentation
|
752
752
|
#
|
@@ -765,28 +765,28 @@ module Aws::OpenSearchServerless
|
|
765
765
|
#
|
766
766
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
|
767
767
|
#
|
768
|
-
# @option params [String] :
|
769
|
-
#
|
770
|
-
# request.
|
768
|
+
# @option params [required, String] :name
|
769
|
+
# Name of the collection.
|
771
770
|
#
|
772
|
-
#
|
773
|
-
#
|
771
|
+
# @option params [String] :type
|
772
|
+
# The type of collection.
|
774
773
|
#
|
775
774
|
# @option params [String] :description
|
776
775
|
# Description of the collection.
|
777
776
|
#
|
778
|
-
# @option params [
|
779
|
-
#
|
777
|
+
# @option params [Array<Types::Tag>] :tags
|
778
|
+
# An arbitrary set of tags (key–value pairs) to associate with the
|
779
|
+
# OpenSearch Serverless collection.
|
780
780
|
#
|
781
781
|
# @option params [String] :standby_replicas
|
782
782
|
# Indicates whether standby replicas should be used for a collection.
|
783
783
|
#
|
784
|
-
# @option params [
|
785
|
-
#
|
786
|
-
#
|
784
|
+
# @option params [String] :client_token
|
785
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
786
|
+
# request.
|
787
787
|
#
|
788
|
-
#
|
789
|
-
#
|
788
|
+
# **A suitable default value is auto-generated.** You should normally
|
789
|
+
# not need to pass this option.**
|
790
790
|
#
|
791
791
|
# @return [Types::CreateCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
792
792
|
#
|
@@ -795,31 +795,31 @@ module Aws::OpenSearchServerless
|
|
795
795
|
# @example Request syntax with placeholder values
|
796
796
|
#
|
797
797
|
# resp = client.create_collection({
|
798
|
-
# client_token: "ClientToken",
|
799
|
-
# description: "CreateCollectionRequestDescriptionString",
|
800
798
|
# name: "CollectionName", # required
|
801
|
-
#
|
799
|
+
# type: "SEARCH", # accepts SEARCH, TIMESERIES, VECTORSEARCH
|
800
|
+
# description: "CreateCollectionRequestDescriptionString",
|
802
801
|
# tags: [
|
803
802
|
# {
|
804
803
|
# key: "TagKey", # required
|
805
804
|
# value: "TagValue", # required
|
806
805
|
# },
|
807
806
|
# ],
|
808
|
-
#
|
807
|
+
# standby_replicas: "ENABLED", # accepts ENABLED, DISABLED
|
808
|
+
# client_token: "ClientToken",
|
809
809
|
# })
|
810
810
|
#
|
811
811
|
# @example Response structure
|
812
812
|
#
|
813
|
-
# resp.create_collection_detail.arn #=> String
|
814
|
-
# resp.create_collection_detail.created_date #=> Integer
|
815
|
-
# resp.create_collection_detail.description #=> String
|
816
813
|
# resp.create_collection_detail.id #=> String
|
817
|
-
# resp.create_collection_detail.kms_key_arn #=> String
|
818
|
-
# resp.create_collection_detail.last_modified_date #=> Integer
|
819
814
|
# resp.create_collection_detail.name #=> String
|
820
|
-
# resp.create_collection_detail.standby_replicas #=> String, one of "ENABLED", "DISABLED"
|
821
815
|
# resp.create_collection_detail.status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
|
822
816
|
# resp.create_collection_detail.type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
|
817
|
+
# resp.create_collection_detail.description #=> String
|
818
|
+
# resp.create_collection_detail.arn #=> String
|
819
|
+
# resp.create_collection_detail.kms_key_arn #=> String
|
820
|
+
# resp.create_collection_detail.standby_replicas #=> String, one of "ENABLED", "DISABLED"
|
821
|
+
# resp.create_collection_detail.created_date #=> Integer
|
822
|
+
# resp.create_collection_detail.last_modified_date #=> Integer
|
823
823
|
#
|
824
824
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateCollection AWS API Documentation
|
825
825
|
#
|
@@ -839,25 +839,25 @@ module Aws::OpenSearchServerless
|
|
839
839
|
#
|
840
840
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create
|
841
841
|
#
|
842
|
-
# @option params [String] :
|
843
|
-
#
|
844
|
-
# request.
|
842
|
+
# @option params [required, String] :type
|
843
|
+
# The type of lifecycle policy.
|
845
844
|
#
|
846
|
-
#
|
847
|
-
#
|
845
|
+
# @option params [required, String] :name
|
846
|
+
# The name of the lifecycle policy.
|
848
847
|
#
|
849
848
|
# @option params [String] :description
|
850
849
|
# A description of the lifecycle policy.
|
851
850
|
#
|
852
|
-
# @option params [required, String] :name
|
853
|
-
# The name of the lifecycle policy.
|
854
|
-
#
|
855
851
|
# @option params [required, String] :policy
|
856
852
|
# The JSON policy document to use as the content for the lifecycle
|
857
853
|
# policy.
|
858
854
|
#
|
859
|
-
# @option params [
|
860
|
-
#
|
855
|
+
# @option params [String] :client_token
|
856
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
857
|
+
# request.
|
858
|
+
#
|
859
|
+
# **A suitable default value is auto-generated.** You should normally
|
860
|
+
# not need to pass this option.**
|
861
861
|
#
|
862
862
|
# @return [Types::CreateLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
863
863
|
#
|
@@ -866,21 +866,21 @@ module Aws::OpenSearchServerless
|
|
866
866
|
# @example Request syntax with placeholder values
|
867
867
|
#
|
868
868
|
# resp = client.create_lifecycle_policy({
|
869
|
-
#
|
870
|
-
# description: "PolicyDescription",
|
869
|
+
# type: "retention", # required, accepts retention
|
871
870
|
# name: "PolicyName", # required
|
871
|
+
# description: "PolicyDescription",
|
872
872
|
# policy: "PolicyDocument", # required
|
873
|
-
#
|
873
|
+
# client_token: "ClientToken",
|
874
874
|
# })
|
875
875
|
#
|
876
876
|
# @example Response structure
|
877
877
|
#
|
878
|
-
# resp.lifecycle_policy_detail.
|
879
|
-
# resp.lifecycle_policy_detail.description #=> String
|
880
|
-
# resp.lifecycle_policy_detail.last_modified_date #=> Integer
|
878
|
+
# resp.lifecycle_policy_detail.type #=> String, one of "retention"
|
881
879
|
# resp.lifecycle_policy_detail.name #=> String
|
882
880
|
# resp.lifecycle_policy_detail.policy_version #=> String
|
883
|
-
# resp.lifecycle_policy_detail.
|
881
|
+
# resp.lifecycle_policy_detail.description #=> String
|
882
|
+
# resp.lifecycle_policy_detail.created_date #=> Integer
|
883
|
+
# resp.lifecycle_policy_detail.last_modified_date #=> Integer
|
884
884
|
#
|
885
885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateLifecyclePolicy AWS API Documentation
|
886
886
|
#
|
@@ -899,30 +899,30 @@ module Aws::OpenSearchServerless
|
|
899
899
|
#
|
900
900
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html
|
901
901
|
#
|
902
|
-
# @option params [String] :
|
903
|
-
#
|
904
|
-
# request.
|
902
|
+
# @option params [required, String] :type
|
903
|
+
# The type of security configuration.
|
905
904
|
#
|
906
|
-
#
|
907
|
-
#
|
905
|
+
# @option params [required, String] :name
|
906
|
+
# The name of the security configuration.
|
908
907
|
#
|
909
908
|
# @option params [String] :description
|
910
909
|
# A description of the security configuration.
|
911
910
|
#
|
911
|
+
# @option params [Types::SamlConfigOptions] :saml_options
|
912
|
+
# Describes SAML options in in the form of a key-value map. This field
|
913
|
+
# is required if you specify `saml` for the `type` parameter.
|
914
|
+
#
|
912
915
|
# @option params [Types::CreateIamIdentityCenterConfigOptions] :iam_identity_center_options
|
913
916
|
# Describes IAM Identity Center options in the form of a key-value map.
|
914
917
|
# This field is required if you specify iamidentitycenter for the type
|
915
918
|
# parameter.
|
916
919
|
#
|
917
|
-
# @option params [
|
918
|
-
#
|
919
|
-
#
|
920
|
-
# @option params [Types::SamlConfigOptions] :saml_options
|
921
|
-
# Describes SAML options in in the form of a key-value map. This field
|
922
|
-
# is required if you specify `saml` for the `type` parameter.
|
920
|
+
# @option params [String] :client_token
|
921
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
922
|
+
# request.
|
923
923
|
#
|
924
|
-
#
|
925
|
-
#
|
924
|
+
# **A suitable default value is auto-generated.** You should normally
|
925
|
+
# not need to pass this option.**
|
926
926
|
#
|
927
927
|
# @return [Types::CreateSecurityConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
928
|
#
|
@@ -931,41 +931,43 @@ module Aws::OpenSearchServerless
|
|
931
931
|
# @example Request syntax with placeholder values
|
932
932
|
#
|
933
933
|
# resp = client.create_security_config({
|
934
|
-
#
|
935
|
-
# description: "ConfigDescription",
|
936
|
-
# iam_identity_center_options: {
|
937
|
-
# group_attribute: "GroupId", # accepts GroupId, GroupName
|
938
|
-
# instance_arn: "IamIdentityCenterInstanceArn", # required
|
939
|
-
# user_attribute: "UserId", # accepts UserId, UserName, Email
|
940
|
-
# },
|
934
|
+
# type: "saml", # required, accepts saml, iamidentitycenter
|
941
935
|
# name: "ConfigName", # required
|
936
|
+
# description: "ConfigDescription",
|
942
937
|
# saml_options: {
|
943
|
-
# group_attribute: "samlGroupAttribute",
|
944
938
|
# metadata: "samlMetadata", # required
|
945
|
-
# session_timeout: 1,
|
946
939
|
# user_attribute: "samlUserAttribute",
|
940
|
+
# group_attribute: "samlGroupAttribute",
|
941
|
+
# open_search_serverless_entity_id: "openSearchServerlessEntityId",
|
942
|
+
# session_timeout: 1,
|
947
943
|
# },
|
948
|
-
#
|
944
|
+
# iam_identity_center_options: {
|
945
|
+
# instance_arn: "IamIdentityCenterInstanceArn", # required
|
946
|
+
# user_attribute: "UserId", # accepts UserId, UserName, Email
|
947
|
+
# group_attribute: "GroupId", # accepts GroupId, GroupName
|
948
|
+
# },
|
949
|
+
# client_token: "ClientToken",
|
949
950
|
# })
|
950
951
|
#
|
951
952
|
# @example Response structure
|
952
953
|
#
|
954
|
+
# resp.security_config_detail.id #=> String
|
955
|
+
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
953
956
|
# resp.security_config_detail.config_version #=> String
|
954
|
-
# resp.security_config_detail.created_date #=> Integer
|
955
957
|
# resp.security_config_detail.description #=> String
|
958
|
+
# resp.security_config_detail.saml_options.metadata #=> String
|
959
|
+
# resp.security_config_detail.saml_options.user_attribute #=> String
|
960
|
+
# resp.security_config_detail.saml_options.group_attribute #=> String
|
961
|
+
# resp.security_config_detail.saml_options.open_search_serverless_entity_id #=> String
|
962
|
+
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
963
|
+
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
956
964
|
# resp.security_config_detail.iam_identity_center_options.application_arn #=> String
|
957
|
-
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
958
965
|
# resp.security_config_detail.iam_identity_center_options.application_name #=> String
|
959
|
-
# resp.security_config_detail.iam_identity_center_options.
|
960
|
-
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
966
|
+
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
961
967
|
# resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
|
962
|
-
# resp.security_config_detail.
|
968
|
+
# resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
|
969
|
+
# resp.security_config_detail.created_date #=> Integer
|
963
970
|
# resp.security_config_detail.last_modified_date #=> Integer
|
964
|
-
# resp.security_config_detail.saml_options.group_attribute #=> String
|
965
|
-
# resp.security_config_detail.saml_options.metadata #=> String
|
966
|
-
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
967
|
-
# resp.security_config_detail.saml_options.user_attribute #=> String
|
968
|
-
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
969
971
|
#
|
970
972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityConfig AWS API Documentation
|
971
973
|
#
|
@@ -989,25 +991,25 @@ module Aws::OpenSearchServerless
|
|
989
991
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html
|
990
992
|
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html
|
991
993
|
#
|
992
|
-
# @option params [String] :
|
993
|
-
#
|
994
|
-
# request.
|
994
|
+
# @option params [required, String] :type
|
995
|
+
# The type of security policy.
|
995
996
|
#
|
996
|
-
#
|
997
|
-
#
|
997
|
+
# @option params [required, String] :name
|
998
|
+
# The name of the policy.
|
998
999
|
#
|
999
1000
|
# @option params [String] :description
|
1000
1001
|
# A description of the policy. Typically used to store information about
|
1001
1002
|
# the permissions defined in the policy.
|
1002
1003
|
#
|
1003
|
-
# @option params [required, String] :name
|
1004
|
-
# The name of the policy.
|
1005
|
-
#
|
1006
1004
|
# @option params [required, String] :policy
|
1007
1005
|
# The JSON policy document to use as the content for the new policy.
|
1008
1006
|
#
|
1009
|
-
# @option params [
|
1010
|
-
#
|
1007
|
+
# @option params [String] :client_token
|
1008
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
1009
|
+
# request.
|
1010
|
+
#
|
1011
|
+
# **A suitable default value is auto-generated.** You should normally
|
1012
|
+
# not need to pass this option.**
|
1011
1013
|
#
|
1012
1014
|
# @return [Types::CreateSecurityPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1013
1015
|
#
|
@@ -1016,21 +1018,21 @@ module Aws::OpenSearchServerless
|
|
1016
1018
|
# @example Request syntax with placeholder values
|
1017
1019
|
#
|
1018
1020
|
# resp = client.create_security_policy({
|
1019
|
-
#
|
1020
|
-
# description: "PolicyDescription",
|
1021
|
+
# type: "encryption", # required, accepts encryption, network
|
1021
1022
|
# name: "PolicyName", # required
|
1023
|
+
# description: "PolicyDescription",
|
1022
1024
|
# policy: "PolicyDocument", # required
|
1023
|
-
#
|
1025
|
+
# client_token: "ClientToken",
|
1024
1026
|
# })
|
1025
1027
|
#
|
1026
1028
|
# @example Response structure
|
1027
1029
|
#
|
1028
|
-
# resp.security_policy_detail.
|
1029
|
-
# resp.security_policy_detail.description #=> String
|
1030
|
-
# resp.security_policy_detail.last_modified_date #=> Integer
|
1030
|
+
# resp.security_policy_detail.type #=> String, one of "encryption", "network"
|
1031
1031
|
# resp.security_policy_detail.name #=> String
|
1032
1032
|
# resp.security_policy_detail.policy_version #=> String
|
1033
|
-
# resp.security_policy_detail.
|
1033
|
+
# resp.security_policy_detail.description #=> String
|
1034
|
+
# resp.security_policy_detail.created_date #=> Integer
|
1035
|
+
# resp.security_policy_detail.last_modified_date #=> Integer
|
1034
1036
|
#
|
1035
1037
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateSecurityPolicy AWS API Documentation
|
1036
1038
|
#
|
@@ -1049,27 +1051,27 @@ module Aws::OpenSearchServerless
|
|
1049
1051
|
#
|
1050
1052
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html
|
1051
1053
|
#
|
1052
|
-
# @option params [String] :client_token
|
1053
|
-
# Unique, case-sensitive identifier to ensure idempotency of the
|
1054
|
-
# request.
|
1055
|
-
#
|
1056
|
-
# **A suitable default value is auto-generated.** You should normally
|
1057
|
-
# not need to pass this option.**
|
1058
|
-
#
|
1059
1054
|
# @option params [required, String] :name
|
1060
1055
|
# The name of the interface endpoint.
|
1061
1056
|
#
|
1057
|
+
# @option params [required, String] :vpc_id
|
1058
|
+
# The ID of the VPC from which you'll access OpenSearch Serverless.
|
1059
|
+
#
|
1060
|
+
# @option params [required, Array<String>] :subnet_ids
|
1061
|
+
# The ID of one or more subnets from which you'll access OpenSearch
|
1062
|
+
# Serverless.
|
1063
|
+
#
|
1062
1064
|
# @option params [Array<String>] :security_group_ids
|
1063
1065
|
# The unique identifiers of the security groups that define the ports,
|
1064
1066
|
# protocols, and sources for inbound traffic that you are authorizing
|
1065
1067
|
# into your endpoint.
|
1066
1068
|
#
|
1067
|
-
# @option params [
|
1068
|
-
#
|
1069
|
-
#
|
1069
|
+
# @option params [String] :client_token
|
1070
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
1071
|
+
# request.
|
1070
1072
|
#
|
1071
|
-
#
|
1072
|
-
#
|
1073
|
+
# **A suitable default value is auto-generated.** You should normally
|
1074
|
+
# not need to pass this option.**
|
1073
1075
|
#
|
1074
1076
|
# @return [Types::CreateVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
1077
|
#
|
@@ -1078,11 +1080,11 @@ module Aws::OpenSearchServerless
|
|
1078
1080
|
# @example Request syntax with placeholder values
|
1079
1081
|
#
|
1080
1082
|
# resp = client.create_vpc_endpoint({
|
1081
|
-
# client_token: "ClientToken",
|
1082
1083
|
# name: "VpcEndpointName", # required
|
1083
|
-
# security_group_ids: ["SecurityGroupId"],
|
1084
|
-
# subnet_ids: ["SubnetId"], # required
|
1085
1084
|
# vpc_id: "VpcId", # required
|
1085
|
+
# subnet_ids: ["SubnetId"], # required
|
1086
|
+
# security_group_ids: ["SecurityGroupId"],
|
1087
|
+
# client_token: "ClientToken",
|
1086
1088
|
# })
|
1087
1089
|
#
|
1088
1090
|
# @example Response structure
|
@@ -1107,6 +1109,12 @@ module Aws::OpenSearchServerless
|
|
1107
1109
|
#
|
1108
1110
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
1109
1111
|
#
|
1112
|
+
# @option params [required, String] :type
|
1113
|
+
# The type of policy.
|
1114
|
+
#
|
1115
|
+
# @option params [required, String] :name
|
1116
|
+
# The name of the policy to delete.
|
1117
|
+
#
|
1110
1118
|
# @option params [String] :client_token
|
1111
1119
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1112
1120
|
# request.
|
@@ -1114,20 +1122,14 @@ module Aws::OpenSearchServerless
|
|
1114
1122
|
# **A suitable default value is auto-generated.** You should normally
|
1115
1123
|
# not need to pass this option.**
|
1116
1124
|
#
|
1117
|
-
# @option params [required, String] :name
|
1118
|
-
# The name of the policy to delete.
|
1119
|
-
#
|
1120
|
-
# @option params [required, String] :type
|
1121
|
-
# The type of policy.
|
1122
|
-
#
|
1123
1125
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1124
1126
|
#
|
1125
1127
|
# @example Request syntax with placeholder values
|
1126
1128
|
#
|
1127
1129
|
# resp = client.delete_access_policy({
|
1128
|
-
# client_token: "ClientToken",
|
1129
|
-
# name: "PolicyName", # required
|
1130
1130
|
# type: "data", # required, accepts data
|
1131
|
+
# name: "PolicyName", # required
|
1132
|
+
# client_token: "ClientToken",
|
1131
1133
|
# })
|
1132
1134
|
#
|
1133
1135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteAccessPolicy AWS API Documentation
|
@@ -1146,13 +1148,6 @@ module Aws::OpenSearchServerless
|
|
1146
1148
|
#
|
1147
1149
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
|
1148
1150
|
#
|
1149
|
-
# @option params [String] :client_token
|
1150
|
-
# A unique, case-sensitive identifier to ensure idempotency of the
|
1151
|
-
# request.
|
1152
|
-
#
|
1153
|
-
# **A suitable default value is auto-generated.** You should normally
|
1154
|
-
# not need to pass this option.**
|
1155
|
-
#
|
1156
1151
|
# @option params [required, String] :id
|
1157
1152
|
# The unique identifier of the collection. For example, `1iu5usc406kd`.
|
1158
1153
|
# The ID is part of the collection endpoint. You can also retrieve it
|
@@ -1162,6 +1157,13 @@ module Aws::OpenSearchServerless
|
|
1162
1157
|
#
|
1163
1158
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html
|
1164
1159
|
#
|
1160
|
+
# @option params [String] :client_token
|
1161
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
1162
|
+
# request.
|
1163
|
+
#
|
1164
|
+
# **A suitable default value is auto-generated.** You should normally
|
1165
|
+
# not need to pass this option.**
|
1166
|
+
#
|
1165
1167
|
# @return [Types::DeleteCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1166
1168
|
#
|
1167
1169
|
# * {Types::DeleteCollectionResponse#delete_collection_detail #delete_collection_detail} => Types::DeleteCollectionDetail
|
@@ -1169,8 +1171,8 @@ module Aws::OpenSearchServerless
|
|
1169
1171
|
# @example Request syntax with placeholder values
|
1170
1172
|
#
|
1171
1173
|
# resp = client.delete_collection({
|
1172
|
-
# client_token: "ClientToken",
|
1173
1174
|
# id: "CollectionId", # required
|
1175
|
+
# client_token: "ClientToken",
|
1174
1176
|
# })
|
1175
1177
|
#
|
1176
1178
|
# @example Response structure
|
@@ -1195,6 +1197,12 @@ module Aws::OpenSearchServerless
|
|
1195
1197
|
#
|
1196
1198
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete
|
1197
1199
|
#
|
1200
|
+
# @option params [required, String] :type
|
1201
|
+
# The type of lifecycle policy.
|
1202
|
+
#
|
1203
|
+
# @option params [required, String] :name
|
1204
|
+
# The name of the policy to delete.
|
1205
|
+
#
|
1198
1206
|
# @option params [String] :client_token
|
1199
1207
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1200
1208
|
# request.
|
@@ -1202,20 +1210,14 @@ module Aws::OpenSearchServerless
|
|
1202
1210
|
# **A suitable default value is auto-generated.** You should normally
|
1203
1211
|
# not need to pass this option.**
|
1204
1212
|
#
|
1205
|
-
# @option params [required, String] :name
|
1206
|
-
# The name of the policy to delete.
|
1207
|
-
#
|
1208
|
-
# @option params [required, String] :type
|
1209
|
-
# The type of lifecycle policy.
|
1210
|
-
#
|
1211
1213
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1212
1214
|
#
|
1213
1215
|
# @example Request syntax with placeholder values
|
1214
1216
|
#
|
1215
1217
|
# resp = client.delete_lifecycle_policy({
|
1216
|
-
# client_token: "ClientToken",
|
1217
|
-
# name: "PolicyName", # required
|
1218
1218
|
# type: "retention", # required, accepts retention
|
1219
|
+
# name: "PolicyName", # required
|
1220
|
+
# client_token: "ClientToken",
|
1219
1221
|
# })
|
1220
1222
|
#
|
1221
1223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteLifecyclePolicy AWS API Documentation
|
@@ -1235,6 +1237,11 @@ module Aws::OpenSearchServerless
|
|
1235
1237
|
#
|
1236
1238
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html
|
1237
1239
|
#
|
1240
|
+
# @option params [required, String] :id
|
1241
|
+
# The security configuration identifier. For SAML the ID will be
|
1242
|
+
# `saml/<accountId>/<idpProviderName>`. For example,
|
1243
|
+
# `saml/123456789123/OKTADev`.
|
1244
|
+
#
|
1238
1245
|
# @option params [String] :client_token
|
1239
1246
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1240
1247
|
# request.
|
@@ -1242,18 +1249,13 @@ module Aws::OpenSearchServerless
|
|
1242
1249
|
# **A suitable default value is auto-generated.** You should normally
|
1243
1250
|
# not need to pass this option.**
|
1244
1251
|
#
|
1245
|
-
# @option params [required, String] :id
|
1246
|
-
# The security configuration identifier. For SAML the ID will be
|
1247
|
-
# `saml/<accountId>/<idpProviderName>`. For example,
|
1248
|
-
# `saml/123456789123/OKTADev`.
|
1249
|
-
#
|
1250
1252
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1251
1253
|
#
|
1252
1254
|
# @example Request syntax with placeholder values
|
1253
1255
|
#
|
1254
1256
|
# resp = client.delete_security_config({
|
1255
|
-
# client_token: "ClientToken",
|
1256
1257
|
# id: "SecurityConfigId", # required
|
1258
|
+
# client_token: "ClientToken",
|
1257
1259
|
# })
|
1258
1260
|
#
|
1259
1261
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityConfig AWS API Documentation
|
@@ -1267,6 +1269,12 @@ module Aws::OpenSearchServerless
|
|
1267
1269
|
|
1268
1270
|
# Deletes an OpenSearch Serverless security policy.
|
1269
1271
|
#
|
1272
|
+
# @option params [required, String] :type
|
1273
|
+
# The type of policy.
|
1274
|
+
#
|
1275
|
+
# @option params [required, String] :name
|
1276
|
+
# The name of the policy to delete.
|
1277
|
+
#
|
1270
1278
|
# @option params [String] :client_token
|
1271
1279
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1272
1280
|
# request.
|
@@ -1274,20 +1282,14 @@ module Aws::OpenSearchServerless
|
|
1274
1282
|
# **A suitable default value is auto-generated.** You should normally
|
1275
1283
|
# not need to pass this option.**
|
1276
1284
|
#
|
1277
|
-
# @option params [required, String] :name
|
1278
|
-
# The name of the policy to delete.
|
1279
|
-
#
|
1280
|
-
# @option params [required, String] :type
|
1281
|
-
# The type of policy.
|
1282
|
-
#
|
1283
1285
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1284
1286
|
#
|
1285
1287
|
# @example Request syntax with placeholder values
|
1286
1288
|
#
|
1287
1289
|
# resp = client.delete_security_policy({
|
1288
|
-
# client_token: "ClientToken",
|
1289
|
-
# name: "PolicyName", # required
|
1290
1290
|
# type: "encryption", # required, accepts encryption, network
|
1291
|
+
# name: "PolicyName", # required
|
1292
|
+
# client_token: "ClientToken",
|
1291
1293
|
# })
|
1292
1294
|
#
|
1293
1295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteSecurityPolicy AWS API Documentation
|
@@ -1307,6 +1309,9 @@ module Aws::OpenSearchServerless
|
|
1307
1309
|
#
|
1308
1310
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html
|
1309
1311
|
#
|
1312
|
+
# @option params [required, String] :id
|
1313
|
+
# The VPC endpoint identifier.
|
1314
|
+
#
|
1310
1315
|
# @option params [String] :client_token
|
1311
1316
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
1312
1317
|
# request.
|
@@ -1314,9 +1319,6 @@ module Aws::OpenSearchServerless
|
|
1314
1319
|
# **A suitable default value is auto-generated.** You should normally
|
1315
1320
|
# not need to pass this option.**
|
1316
1321
|
#
|
1317
|
-
# @option params [required, String] :id
|
1318
|
-
# The VPC endpoint identifier.
|
1319
|
-
#
|
1320
1322
|
# @return [Types::DeleteVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
1323
|
#
|
1322
1324
|
# * {Types::DeleteVpcEndpointResponse#delete_vpc_endpoint_detail #delete_vpc_endpoint_detail} => Types::DeleteVpcEndpointDetail
|
@@ -1324,8 +1326,8 @@ module Aws::OpenSearchServerless
|
|
1324
1326
|
# @example Request syntax with placeholder values
|
1325
1327
|
#
|
1326
1328
|
# resp = client.delete_vpc_endpoint({
|
1327
|
-
# client_token: "ClientToken",
|
1328
1329
|
# id: "VpcEndpointId", # required
|
1330
|
+
# client_token: "ClientToken",
|
1329
1331
|
# })
|
1330
1332
|
#
|
1331
1333
|
# @example Response structure
|
@@ -1350,12 +1352,12 @@ module Aws::OpenSearchServerless
|
|
1350
1352
|
#
|
1351
1353
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
1352
1354
|
#
|
1353
|
-
# @option params [required, String] :name
|
1354
|
-
# The name of the access policy.
|
1355
|
-
#
|
1356
1355
|
# @option params [required, String] :type
|
1357
1356
|
# Tye type of policy. Currently, the only supported value is `data`.
|
1358
1357
|
#
|
1358
|
+
# @option params [required, String] :name
|
1359
|
+
# The name of the access policy.
|
1360
|
+
#
|
1359
1361
|
# @return [Types::GetAccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1360
1362
|
#
|
1361
1363
|
# * {Types::GetAccessPolicyResponse#access_policy_detail #access_policy_detail} => Types::AccessPolicyDetail
|
@@ -1363,18 +1365,18 @@ module Aws::OpenSearchServerless
|
|
1363
1365
|
# @example Request syntax with placeholder values
|
1364
1366
|
#
|
1365
1367
|
# resp = client.get_access_policy({
|
1366
|
-
# name: "PolicyName", # required
|
1367
1368
|
# type: "data", # required, accepts data
|
1369
|
+
# name: "PolicyName", # required
|
1368
1370
|
# })
|
1369
1371
|
#
|
1370
1372
|
# @example Response structure
|
1371
1373
|
#
|
1372
|
-
# resp.access_policy_detail.
|
1373
|
-
# resp.access_policy_detail.description #=> String
|
1374
|
-
# resp.access_policy_detail.last_modified_date #=> Integer
|
1374
|
+
# resp.access_policy_detail.type #=> String, one of "data"
|
1375
1375
|
# resp.access_policy_detail.name #=> String
|
1376
1376
|
# resp.access_policy_detail.policy_version #=> String
|
1377
|
-
# resp.access_policy_detail.
|
1377
|
+
# resp.access_policy_detail.description #=> String
|
1378
|
+
# resp.access_policy_detail.created_date #=> Integer
|
1379
|
+
# resp.access_policy_detail.last_modified_date #=> Integer
|
1378
1380
|
#
|
1379
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetAccessPolicy AWS API Documentation
|
1380
1382
|
#
|
@@ -1411,18 +1413,18 @@ module Aws::OpenSearchServerless
|
|
1411
1413
|
# @return [Types::GetPoliciesStatsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1412
1414
|
#
|
1413
1415
|
# * {Types::GetPoliciesStatsResponse#access_policy_stats #access_policy_stats} => Types::AccessPolicyStats
|
1414
|
-
# * {Types::GetPoliciesStatsResponse#lifecycle_policy_stats #lifecycle_policy_stats} => Types::LifecyclePolicyStats
|
1415
|
-
# * {Types::GetPoliciesStatsResponse#security_config_stats #security_config_stats} => Types::SecurityConfigStats
|
1416
1416
|
# * {Types::GetPoliciesStatsResponse#security_policy_stats #security_policy_stats} => Types::SecurityPolicyStats
|
1417
|
+
# * {Types::GetPoliciesStatsResponse#security_config_stats #security_config_stats} => Types::SecurityConfigStats
|
1418
|
+
# * {Types::GetPoliciesStatsResponse#lifecycle_policy_stats #lifecycle_policy_stats} => Types::LifecyclePolicyStats
|
1417
1419
|
# * {Types::GetPoliciesStatsResponse#total_policy_count #total_policy_count} => Integer
|
1418
1420
|
#
|
1419
1421
|
# @example Response structure
|
1420
1422
|
#
|
1421
1423
|
# resp.access_policy_stats.data_policy_count #=> Integer
|
1422
|
-
# resp.lifecycle_policy_stats.retention_policy_count #=> Integer
|
1423
|
-
# resp.security_config_stats.saml_config_count #=> Integer
|
1424
1424
|
# resp.security_policy_stats.encryption_policy_count #=> Integer
|
1425
1425
|
# resp.security_policy_stats.network_policy_count #=> Integer
|
1426
|
+
# resp.security_config_stats.saml_config_count #=> Integer
|
1427
|
+
# resp.lifecycle_policy_stats.retention_policy_count #=> Integer
|
1426
1428
|
# resp.total_policy_count #=> Integer
|
1427
1429
|
#
|
1428
1430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetPoliciesStats AWS API Documentation
|
@@ -1457,22 +1459,23 @@ module Aws::OpenSearchServerless
|
|
1457
1459
|
#
|
1458
1460
|
# @example Response structure
|
1459
1461
|
#
|
1462
|
+
# resp.security_config_detail.id #=> String
|
1463
|
+
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
1460
1464
|
# resp.security_config_detail.config_version #=> String
|
1461
|
-
# resp.security_config_detail.created_date #=> Integer
|
1462
1465
|
# resp.security_config_detail.description #=> String
|
1466
|
+
# resp.security_config_detail.saml_options.metadata #=> String
|
1467
|
+
# resp.security_config_detail.saml_options.user_attribute #=> String
|
1468
|
+
# resp.security_config_detail.saml_options.group_attribute #=> String
|
1469
|
+
# resp.security_config_detail.saml_options.open_search_serverless_entity_id #=> String
|
1470
|
+
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
1471
|
+
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
1463
1472
|
# resp.security_config_detail.iam_identity_center_options.application_arn #=> String
|
1464
|
-
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
1465
1473
|
# resp.security_config_detail.iam_identity_center_options.application_name #=> String
|
1466
|
-
# resp.security_config_detail.iam_identity_center_options.
|
1467
|
-
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
1474
|
+
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
1468
1475
|
# resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
|
1469
|
-
# resp.security_config_detail.
|
1476
|
+
# resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
|
1477
|
+
# resp.security_config_detail.created_date #=> Integer
|
1470
1478
|
# resp.security_config_detail.last_modified_date #=> Integer
|
1471
|
-
# resp.security_config_detail.saml_options.group_attribute #=> String
|
1472
|
-
# resp.security_config_detail.saml_options.metadata #=> String
|
1473
|
-
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
1474
|
-
# resp.security_config_detail.saml_options.user_attribute #=> String
|
1475
|
-
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
1476
1479
|
#
|
1477
1480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityConfig AWS API Documentation
|
1478
1481
|
#
|
@@ -1493,12 +1496,12 @@ module Aws::OpenSearchServerless
|
|
1493
1496
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html
|
1494
1497
|
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html
|
1495
1498
|
#
|
1496
|
-
# @option params [required, String] :name
|
1497
|
-
# The name of the security policy.
|
1498
|
-
#
|
1499
1499
|
# @option params [required, String] :type
|
1500
1500
|
# The type of security policy.
|
1501
1501
|
#
|
1502
|
+
# @option params [required, String] :name
|
1503
|
+
# The name of the security policy.
|
1504
|
+
#
|
1502
1505
|
# @return [Types::GetSecurityPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1503
1506
|
#
|
1504
1507
|
# * {Types::GetSecurityPolicyResponse#security_policy_detail #security_policy_detail} => Types::SecurityPolicyDetail
|
@@ -1506,18 +1509,18 @@ module Aws::OpenSearchServerless
|
|
1506
1509
|
# @example Request syntax with placeholder values
|
1507
1510
|
#
|
1508
1511
|
# resp = client.get_security_policy({
|
1509
|
-
# name: "PolicyName", # required
|
1510
1512
|
# type: "encryption", # required, accepts encryption, network
|
1513
|
+
# name: "PolicyName", # required
|
1511
1514
|
# })
|
1512
1515
|
#
|
1513
1516
|
# @example Response structure
|
1514
1517
|
#
|
1515
|
-
# resp.security_policy_detail.
|
1516
|
-
# resp.security_policy_detail.description #=> String
|
1517
|
-
# resp.security_policy_detail.last_modified_date #=> Integer
|
1518
|
+
# resp.security_policy_detail.type #=> String, one of "encryption", "network"
|
1518
1519
|
# resp.security_policy_detail.name #=> String
|
1519
1520
|
# resp.security_policy_detail.policy_version #=> String
|
1520
|
-
# resp.security_policy_detail.
|
1521
|
+
# resp.security_policy_detail.description #=> String
|
1522
|
+
# resp.security_policy_detail.created_date #=> Integer
|
1523
|
+
# resp.security_policy_detail.last_modified_date #=> Integer
|
1521
1524
|
#
|
1522
1525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/GetSecurityPolicy AWS API Documentation
|
1523
1526
|
#
|
@@ -1531,10 +1534,12 @@ module Aws::OpenSearchServerless
|
|
1531
1534
|
# Returns information about a list of OpenSearch Serverless access
|
1532
1535
|
# policies.
|
1533
1536
|
#
|
1534
|
-
# @option params [
|
1535
|
-
#
|
1536
|
-
#
|
1537
|
-
#
|
1537
|
+
# @option params [required, String] :type
|
1538
|
+
# The type of access policy.
|
1539
|
+
#
|
1540
|
+
# @option params [Array<String>] :resource
|
1541
|
+
# Resource filters (can be collections or indexes) that policies can
|
1542
|
+
# apply to.
|
1538
1543
|
#
|
1539
1544
|
# @option params [String] :next_token
|
1540
1545
|
# If your initial `ListAccessPolicies` operation returns a `nextToken`,
|
@@ -1542,12 +1547,10 @@ module Aws::OpenSearchServerless
|
|
1542
1547
|
# `ListAccessPolicies` operations, which returns results in the next
|
1543
1548
|
# page.
|
1544
1549
|
#
|
1545
|
-
# @option params [
|
1546
|
-
#
|
1547
|
-
#
|
1548
|
-
#
|
1549
|
-
# @option params [required, String] :type
|
1550
|
-
# The type of access policy.
|
1550
|
+
# @option params [Integer] :max_results
|
1551
|
+
# An optional parameter that specifies the maximum number of results to
|
1552
|
+
# return. You can use `nextToken` to get the next page of results. The
|
1553
|
+
# default is 20.
|
1551
1554
|
#
|
1552
1555
|
# @return [Types::ListAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1553
1556
|
#
|
@@ -1559,21 +1562,21 @@ module Aws::OpenSearchServerless
|
|
1559
1562
|
# @example Request syntax with placeholder values
|
1560
1563
|
#
|
1561
1564
|
# resp = client.list_access_policies({
|
1562
|
-
# max_results: 1,
|
1563
|
-
# next_token: "String",
|
1564
|
-
# resource: ["Resource"],
|
1565
1565
|
# type: "data", # required, accepts data
|
1566
|
+
# resource: ["Resource"],
|
1567
|
+
# next_token: "String",
|
1568
|
+
# max_results: 1,
|
1566
1569
|
# })
|
1567
1570
|
#
|
1568
1571
|
# @example Response structure
|
1569
1572
|
#
|
1570
1573
|
# resp.access_policy_summaries #=> Array
|
1571
|
-
# resp.access_policy_summaries[0].
|
1572
|
-
# resp.access_policy_summaries[0].description #=> String
|
1573
|
-
# resp.access_policy_summaries[0].last_modified_date #=> Integer
|
1574
|
+
# resp.access_policy_summaries[0].type #=> String, one of "data"
|
1574
1575
|
# resp.access_policy_summaries[0].name #=> String
|
1575
1576
|
# resp.access_policy_summaries[0].policy_version #=> String
|
1576
|
-
# resp.access_policy_summaries[0].
|
1577
|
+
# resp.access_policy_summaries[0].description #=> String
|
1578
|
+
# resp.access_policy_summaries[0].created_date #=> Integer
|
1579
|
+
# resp.access_policy_summaries[0].last_modified_date #=> Integer
|
1577
1580
|
# resp.next_token #=> String
|
1578
1581
|
#
|
1579
1582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListAccessPolicies AWS API Documentation
|
@@ -1600,15 +1603,15 @@ module Aws::OpenSearchServerless
|
|
1600
1603
|
# @option params [Types::CollectionFilters] :collection_filters
|
1601
1604
|
# A list of filter names and values that you can use for requests.
|
1602
1605
|
#
|
1603
|
-
# @option params [Integer] :max_results
|
1604
|
-
# The maximum number of results to return. Default is 20. You can use
|
1605
|
-
# `nextToken` to get the next page of results.
|
1606
|
-
#
|
1607
1606
|
# @option params [String] :next_token
|
1608
1607
|
# If your initial `ListCollections` operation returns a `nextToken`, you
|
1609
1608
|
# can include the returned `nextToken` in subsequent `ListCollections`
|
1610
1609
|
# operations, which returns results in the next page.
|
1611
1610
|
#
|
1611
|
+
# @option params [Integer] :max_results
|
1612
|
+
# The maximum number of results to return. Default is 20. You can use
|
1613
|
+
# `nextToken` to get the next page of results.
|
1614
|
+
#
|
1612
1615
|
# @return [Types::ListCollectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1613
1616
|
#
|
1614
1617
|
# * {Types::ListCollectionsResponse#collection_summaries #collection_summaries} => Array<Types::CollectionSummary>
|
@@ -1623,17 +1626,17 @@ module Aws::OpenSearchServerless
|
|
1623
1626
|
# name: "CollectionName",
|
1624
1627
|
# status: "CREATING", # accepts CREATING, DELETING, ACTIVE, FAILED
|
1625
1628
|
# },
|
1626
|
-
# max_results: 1,
|
1627
1629
|
# next_token: "String",
|
1630
|
+
# max_results: 1,
|
1628
1631
|
# })
|
1629
1632
|
#
|
1630
1633
|
# @example Response structure
|
1631
1634
|
#
|
1632
1635
|
# resp.collection_summaries #=> Array
|
1633
|
-
# resp.collection_summaries[0].arn #=> String
|
1634
1636
|
# resp.collection_summaries[0].id #=> String
|
1635
1637
|
# resp.collection_summaries[0].name #=> String
|
1636
1638
|
# resp.collection_summaries[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
|
1639
|
+
# resp.collection_summaries[0].arn #=> String
|
1637
1640
|
# resp.next_token #=> String
|
1638
1641
|
#
|
1639
1642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListCollections AWS API Documentation
|
@@ -1652,10 +1655,12 @@ module Aws::OpenSearchServerless
|
|
1652
1655
|
#
|
1653
1656
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list
|
1654
1657
|
#
|
1655
|
-
# @option params [
|
1656
|
-
#
|
1657
|
-
#
|
1658
|
-
#
|
1658
|
+
# @option params [required, String] :type
|
1659
|
+
# The type of lifecycle policy.
|
1660
|
+
#
|
1661
|
+
# @option params [Array<String>] :resources
|
1662
|
+
# Resource filters that policies can apply to. Currently, the only
|
1663
|
+
# supported resource type is `index`.
|
1659
1664
|
#
|
1660
1665
|
# @option params [String] :next_token
|
1661
1666
|
# If your initial `ListLifecyclePolicies` operation returns a
|
@@ -1663,12 +1668,10 @@ module Aws::OpenSearchServerless
|
|
1663
1668
|
# `ListLifecyclePolicies` operations, which returns results in the next
|
1664
1669
|
# page.
|
1665
1670
|
#
|
1666
|
-
# @option params [
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
# @option params [required, String] :type
|
1671
|
-
# The type of lifecycle policy.
|
1671
|
+
# @option params [Integer] :max_results
|
1672
|
+
# An optional parameter that specifies the maximum number of results to
|
1673
|
+
# return. You can use use `nextToken` to get the next page of results.
|
1674
|
+
# The default is 10.
|
1672
1675
|
#
|
1673
1676
|
# @return [Types::ListLifecyclePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1674
1677
|
#
|
@@ -1680,21 +1683,21 @@ module Aws::OpenSearchServerless
|
|
1680
1683
|
# @example Request syntax with placeholder values
|
1681
1684
|
#
|
1682
1685
|
# resp = client.list_lifecycle_policies({
|
1683
|
-
# max_results: 1,
|
1684
|
-
# next_token: "String",
|
1685
|
-
# resources: ["LifecycleResource"],
|
1686
1686
|
# type: "retention", # required, accepts retention
|
1687
|
+
# resources: ["LifecycleResource"],
|
1688
|
+
# next_token: "String",
|
1689
|
+
# max_results: 1,
|
1687
1690
|
# })
|
1688
1691
|
#
|
1689
1692
|
# @example Response structure
|
1690
1693
|
#
|
1691
1694
|
# resp.lifecycle_policy_summaries #=> Array
|
1692
|
-
# resp.lifecycle_policy_summaries[0].
|
1693
|
-
# resp.lifecycle_policy_summaries[0].description #=> String
|
1694
|
-
# resp.lifecycle_policy_summaries[0].last_modified_date #=> Integer
|
1695
|
+
# resp.lifecycle_policy_summaries[0].type #=> String, one of "retention"
|
1695
1696
|
# resp.lifecycle_policy_summaries[0].name #=> String
|
1696
1697
|
# resp.lifecycle_policy_summaries[0].policy_version #=> String
|
1697
|
-
# resp.lifecycle_policy_summaries[0].
|
1698
|
+
# resp.lifecycle_policy_summaries[0].description #=> String
|
1699
|
+
# resp.lifecycle_policy_summaries[0].created_date #=> Integer
|
1700
|
+
# resp.lifecycle_policy_summaries[0].last_modified_date #=> Integer
|
1698
1701
|
# resp.next_token #=> String
|
1699
1702
|
#
|
1700
1703
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListLifecyclePolicies AWS API Documentation
|
@@ -1714,10 +1717,8 @@ module Aws::OpenSearchServerless
|
|
1714
1717
|
#
|
1715
1718
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html
|
1716
1719
|
#
|
1717
|
-
# @option params [
|
1718
|
-
#
|
1719
|
-
# return. You can use `nextToken` to get the next page of results. The
|
1720
|
-
# default is 20.
|
1720
|
+
# @option params [required, String] :type
|
1721
|
+
# The type of security configuration.
|
1721
1722
|
#
|
1722
1723
|
# @option params [String] :next_token
|
1723
1724
|
# If your initial `ListSecurityConfigs` operation returns a `nextToken`,
|
@@ -1725,34 +1726,36 @@ module Aws::OpenSearchServerless
|
|
1725
1726
|
# `ListSecurityConfigs` operations, which returns results in the next
|
1726
1727
|
# page.
|
1727
1728
|
#
|
1728
|
-
# @option params [
|
1729
|
-
#
|
1729
|
+
# @option params [Integer] :max_results
|
1730
|
+
# An optional parameter that specifies the maximum number of results to
|
1731
|
+
# return. You can use `nextToken` to get the next page of results. The
|
1732
|
+
# default is 20.
|
1730
1733
|
#
|
1731
1734
|
# @return [Types::ListSecurityConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1732
1735
|
#
|
1733
|
-
# * {Types::ListSecurityConfigsResponse#next_token #next_token} => String
|
1734
1736
|
# * {Types::ListSecurityConfigsResponse#security_config_summaries #security_config_summaries} => Array<Types::SecurityConfigSummary>
|
1737
|
+
# * {Types::ListSecurityConfigsResponse#next_token #next_token} => String
|
1735
1738
|
#
|
1736
1739
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1737
1740
|
#
|
1738
1741
|
# @example Request syntax with placeholder values
|
1739
1742
|
#
|
1740
1743
|
# resp = client.list_security_configs({
|
1741
|
-
# max_results: 1,
|
1742
|
-
# next_token: "String",
|
1743
1744
|
# type: "saml", # required, accepts saml, iamidentitycenter
|
1745
|
+
# next_token: "String",
|
1746
|
+
# max_results: 1,
|
1744
1747
|
# })
|
1745
1748
|
#
|
1746
1749
|
# @example Response structure
|
1747
1750
|
#
|
1748
|
-
# resp.next_token #=> String
|
1749
1751
|
# resp.security_config_summaries #=> Array
|
1752
|
+
# resp.security_config_summaries[0].id #=> String
|
1753
|
+
# resp.security_config_summaries[0].type #=> String, one of "saml", "iamidentitycenter"
|
1750
1754
|
# resp.security_config_summaries[0].config_version #=> String
|
1751
|
-
# resp.security_config_summaries[0].created_date #=> Integer
|
1752
1755
|
# resp.security_config_summaries[0].description #=> String
|
1753
|
-
# resp.security_config_summaries[0].
|
1756
|
+
# resp.security_config_summaries[0].created_date #=> Integer
|
1754
1757
|
# resp.security_config_summaries[0].last_modified_date #=> Integer
|
1755
|
-
# resp.
|
1758
|
+
# resp.next_token #=> String
|
1756
1759
|
#
|
1757
1760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityConfigs AWS API Documentation
|
1758
1761
|
#
|
@@ -1766,10 +1769,12 @@ module Aws::OpenSearchServerless
|
|
1766
1769
|
# Returns information about configured OpenSearch Serverless security
|
1767
1770
|
# policies.
|
1768
1771
|
#
|
1769
|
-
# @option params [
|
1770
|
-
#
|
1771
|
-
#
|
1772
|
-
#
|
1772
|
+
# @option params [required, String] :type
|
1773
|
+
# The type of policy.
|
1774
|
+
#
|
1775
|
+
# @option params [Array<String>] :resource
|
1776
|
+
# Resource filters (can be collection or indexes) that policies can
|
1777
|
+
# apply to.
|
1773
1778
|
#
|
1774
1779
|
# @option params [String] :next_token
|
1775
1780
|
# If your initial `ListSecurityPolicies` operation returns a
|
@@ -1777,39 +1782,37 @@ module Aws::OpenSearchServerless
|
|
1777
1782
|
# `ListSecurityPolicies` operations, which returns results in the next
|
1778
1783
|
# page.
|
1779
1784
|
#
|
1780
|
-
# @option params [
|
1781
|
-
#
|
1782
|
-
#
|
1783
|
-
#
|
1784
|
-
# @option params [required, String] :type
|
1785
|
-
# The type of policy.
|
1785
|
+
# @option params [Integer] :max_results
|
1786
|
+
# An optional parameter that specifies the maximum number of results to
|
1787
|
+
# return. You can use `nextToken` to get the next page of results. The
|
1788
|
+
# default is 20.
|
1786
1789
|
#
|
1787
1790
|
# @return [Types::ListSecurityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
1791
|
#
|
1789
|
-
# * {Types::ListSecurityPoliciesResponse#next_token #next_token} => String
|
1790
1792
|
# * {Types::ListSecurityPoliciesResponse#security_policy_summaries #security_policy_summaries} => Array<Types::SecurityPolicySummary>
|
1793
|
+
# * {Types::ListSecurityPoliciesResponse#next_token #next_token} => String
|
1791
1794
|
#
|
1792
1795
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1793
1796
|
#
|
1794
1797
|
# @example Request syntax with placeholder values
|
1795
1798
|
#
|
1796
1799
|
# resp = client.list_security_policies({
|
1797
|
-
# max_results: 1,
|
1798
|
-
# next_token: "String",
|
1799
|
-
# resource: ["Resource"],
|
1800
1800
|
# type: "encryption", # required, accepts encryption, network
|
1801
|
+
# resource: ["Resource"],
|
1802
|
+
# next_token: "String",
|
1803
|
+
# max_results: 1,
|
1801
1804
|
# })
|
1802
1805
|
#
|
1803
1806
|
# @example Response structure
|
1804
1807
|
#
|
1805
|
-
# resp.next_token #=> String
|
1806
1808
|
# resp.security_policy_summaries #=> Array
|
1807
|
-
# resp.security_policy_summaries[0].
|
1808
|
-
# resp.security_policy_summaries[0].description #=> String
|
1809
|
-
# resp.security_policy_summaries[0].last_modified_date #=> Integer
|
1809
|
+
# resp.security_policy_summaries[0].type #=> String, one of "encryption", "network"
|
1810
1810
|
# resp.security_policy_summaries[0].name #=> String
|
1811
1811
|
# resp.security_policy_summaries[0].policy_version #=> String
|
1812
|
-
# resp.security_policy_summaries[0].
|
1812
|
+
# resp.security_policy_summaries[0].description #=> String
|
1813
|
+
# resp.security_policy_summaries[0].created_date #=> Integer
|
1814
|
+
# resp.security_policy_summaries[0].last_modified_date #=> Integer
|
1815
|
+
# resp.next_token #=> String
|
1813
1816
|
#
|
1814
1817
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListSecurityPolicies AWS API Documentation
|
1815
1818
|
#
|
@@ -1866,45 +1869,45 @@ module Aws::OpenSearchServerless
|
|
1866
1869
|
#
|
1867
1870
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html
|
1868
1871
|
#
|
1869
|
-
# @option params [Integer] :max_results
|
1870
|
-
# An optional parameter that specifies the maximum number of results to
|
1871
|
-
# return. You can use `nextToken` to get the next page of results. The
|
1872
|
-
# default is 20.
|
1873
|
-
#
|
1874
|
-
# @option params [String] :next_token
|
1875
|
-
# If your initial `ListVpcEndpoints` operation returns a `nextToken`,
|
1876
|
-
# you can include the returned `nextToken` in subsequent
|
1877
|
-
# `ListVpcEndpoints` operations, which returns results in the next page.
|
1878
|
-
#
|
1879
1872
|
# @option params [Types::VpcEndpointFilters] :vpc_endpoint_filters
|
1880
1873
|
# Filter the results according to the current status of the VPC
|
1881
1874
|
# endpoint. Possible statuses are `CREATING`, `DELETING`, `UPDATING`,
|
1882
1875
|
# `ACTIVE`, and `FAILED`.
|
1883
1876
|
#
|
1877
|
+
# @option params [String] :next_token
|
1878
|
+
# If your initial `ListVpcEndpoints` operation returns a `nextToken`,
|
1879
|
+
# you can include the returned `nextToken` in subsequent
|
1880
|
+
# `ListVpcEndpoints` operations, which returns results in the next page.
|
1881
|
+
#
|
1882
|
+
# @option params [Integer] :max_results
|
1883
|
+
# An optional parameter that specifies the maximum number of results to
|
1884
|
+
# return. You can use `nextToken` to get the next page of results. The
|
1885
|
+
# default is 20.
|
1886
|
+
#
|
1884
1887
|
# @return [Types::ListVpcEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1885
1888
|
#
|
1886
|
-
# * {Types::ListVpcEndpointsResponse#next_token #next_token} => String
|
1887
1889
|
# * {Types::ListVpcEndpointsResponse#vpc_endpoint_summaries #vpc_endpoint_summaries} => Array<Types::VpcEndpointSummary>
|
1890
|
+
# * {Types::ListVpcEndpointsResponse#next_token #next_token} => String
|
1888
1891
|
#
|
1889
1892
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1890
1893
|
#
|
1891
1894
|
# @example Request syntax with placeholder values
|
1892
1895
|
#
|
1893
1896
|
# resp = client.list_vpc_endpoints({
|
1894
|
-
# max_results: 1,
|
1895
|
-
# next_token: "String",
|
1896
1897
|
# vpc_endpoint_filters: {
|
1897
1898
|
# status: "PENDING", # accepts PENDING, DELETING, ACTIVE, FAILED
|
1898
1899
|
# },
|
1900
|
+
# next_token: "String",
|
1901
|
+
# max_results: 1,
|
1899
1902
|
# })
|
1900
1903
|
#
|
1901
1904
|
# @example Response structure
|
1902
1905
|
#
|
1903
|
-
# resp.next_token #=> String
|
1904
1906
|
# resp.vpc_endpoint_summaries #=> Array
|
1905
1907
|
# resp.vpc_endpoint_summaries[0].id #=> String
|
1906
1908
|
# resp.vpc_endpoint_summaries[0].name #=> String
|
1907
1909
|
# resp.vpc_endpoint_summaries[0].status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"
|
1910
|
+
# resp.next_token #=> String
|
1908
1911
|
#
|
1909
1912
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListVpcEndpoints AWS API Documentation
|
1910
1913
|
#
|
@@ -1997,28 +2000,28 @@ module Aws::OpenSearchServerless
|
|
1997
2000
|
#
|
1998
2001
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
1999
2002
|
#
|
2000
|
-
# @option params [String] :
|
2001
|
-
#
|
2002
|
-
# request.
|
2003
|
+
# @option params [required, String] :type
|
2004
|
+
# The type of policy.
|
2003
2005
|
#
|
2004
|
-
#
|
2005
|
-
#
|
2006
|
+
# @option params [required, String] :name
|
2007
|
+
# The name of the policy.
|
2008
|
+
#
|
2009
|
+
# @option params [required, String] :policy_version
|
2010
|
+
# The version of the policy being updated.
|
2006
2011
|
#
|
2007
2012
|
# @option params [String] :description
|
2008
2013
|
# A description of the policy. Typically used to store information about
|
2009
2014
|
# the permissions defined in the policy.
|
2010
2015
|
#
|
2011
|
-
# @option params [required, String] :name
|
2012
|
-
# The name of the policy.
|
2013
|
-
#
|
2014
2016
|
# @option params [String] :policy
|
2015
2017
|
# The JSON policy document to use as the content for the policy.
|
2016
2018
|
#
|
2017
|
-
# @option params [
|
2018
|
-
#
|
2019
|
+
# @option params [String] :client_token
|
2020
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2021
|
+
# request.
|
2019
2022
|
#
|
2020
|
-
#
|
2021
|
-
#
|
2023
|
+
# **A suitable default value is auto-generated.** You should normally
|
2024
|
+
# not need to pass this option.**
|
2022
2025
|
#
|
2023
2026
|
# @return [Types::UpdateAccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2024
2027
|
#
|
@@ -2027,22 +2030,22 @@ module Aws::OpenSearchServerless
|
|
2027
2030
|
# @example Request syntax with placeholder values
|
2028
2031
|
#
|
2029
2032
|
# resp = client.update_access_policy({
|
2030
|
-
#
|
2031
|
-
# description: "PolicyDescription",
|
2033
|
+
# type: "data", # required, accepts data
|
2032
2034
|
# name: "PolicyName", # required
|
2033
|
-
# policy: "PolicyDocument",
|
2034
2035
|
# policy_version: "PolicyVersion", # required
|
2035
|
-
#
|
2036
|
+
# description: "PolicyDescription",
|
2037
|
+
# policy: "PolicyDocument",
|
2038
|
+
# client_token: "ClientToken",
|
2036
2039
|
# })
|
2037
2040
|
#
|
2038
2041
|
# @example Response structure
|
2039
2042
|
#
|
2040
|
-
# resp.access_policy_detail.
|
2041
|
-
# resp.access_policy_detail.description #=> String
|
2042
|
-
# resp.access_policy_detail.last_modified_date #=> Integer
|
2043
|
+
# resp.access_policy_detail.type #=> String, one of "data"
|
2043
2044
|
# resp.access_policy_detail.name #=> String
|
2044
2045
|
# resp.access_policy_detail.policy_version #=> String
|
2045
|
-
# resp.access_policy_detail.
|
2046
|
+
# resp.access_policy_detail.description #=> String
|
2047
|
+
# resp.access_policy_detail.created_date #=> Integer
|
2048
|
+
# resp.access_policy_detail.last_modified_date #=> Integer
|
2046
2049
|
#
|
2047
2050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateAccessPolicy AWS API Documentation
|
2048
2051
|
#
|
@@ -2100,6 +2103,12 @@ module Aws::OpenSearchServerless
|
|
2100
2103
|
|
2101
2104
|
# Updates an OpenSearch Serverless collection.
|
2102
2105
|
#
|
2106
|
+
# @option params [required, String] :id
|
2107
|
+
# The unique identifier of the collection.
|
2108
|
+
#
|
2109
|
+
# @option params [String] :description
|
2110
|
+
# A description of the collection.
|
2111
|
+
#
|
2103
2112
|
# @option params [String] :client_token
|
2104
2113
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
2105
2114
|
# request.
|
@@ -2107,12 +2116,6 @@ module Aws::OpenSearchServerless
|
|
2107
2116
|
# **A suitable default value is auto-generated.** You should normally
|
2108
2117
|
# not need to pass this option.**
|
2109
2118
|
#
|
2110
|
-
# @option params [String] :description
|
2111
|
-
# A description of the collection.
|
2112
|
-
#
|
2113
|
-
# @option params [required, String] :id
|
2114
|
-
# The unique identifier of the collection.
|
2115
|
-
#
|
2116
2119
|
# @return [Types::UpdateCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2117
2120
|
#
|
2118
2121
|
# * {Types::UpdateCollectionResponse#update_collection_detail #update_collection_detail} => Types::UpdateCollectionDetail
|
@@ -2120,21 +2123,21 @@ module Aws::OpenSearchServerless
|
|
2120
2123
|
# @example Request syntax with placeholder values
|
2121
2124
|
#
|
2122
2125
|
# resp = client.update_collection({
|
2123
|
-
# client_token: "ClientToken",
|
2124
|
-
# description: "UpdateCollectionRequestDescriptionString",
|
2125
2126
|
# id: "CollectionId", # required
|
2127
|
+
# description: "UpdateCollectionRequestDescriptionString",
|
2128
|
+
# client_token: "ClientToken",
|
2126
2129
|
# })
|
2127
2130
|
#
|
2128
2131
|
# @example Response structure
|
2129
2132
|
#
|
2130
|
-
# resp.update_collection_detail.arn #=> String
|
2131
|
-
# resp.update_collection_detail.created_date #=> Integer
|
2132
|
-
# resp.update_collection_detail.description #=> String
|
2133
2133
|
# resp.update_collection_detail.id #=> String
|
2134
|
-
# resp.update_collection_detail.last_modified_date #=> Integer
|
2135
2134
|
# resp.update_collection_detail.name #=> String
|
2136
2135
|
# resp.update_collection_detail.status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
|
2137
2136
|
# resp.update_collection_detail.type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
|
2137
|
+
# resp.update_collection_detail.description #=> String
|
2138
|
+
# resp.update_collection_detail.arn #=> String
|
2139
|
+
# resp.update_collection_detail.created_date #=> Integer
|
2140
|
+
# resp.update_collection_detail.last_modified_date #=> Integer
|
2138
2141
|
#
|
2139
2142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateCollection AWS API Documentation
|
2140
2143
|
#
|
@@ -2152,28 +2155,28 @@ module Aws::OpenSearchServerless
|
|
2152
2155
|
#
|
2153
2156
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update
|
2154
2157
|
#
|
2155
|
-
# @option params [String] :
|
2156
|
-
#
|
2157
|
-
# request.
|
2158
|
+
# @option params [required, String] :type
|
2159
|
+
# The type of lifecycle policy.
|
2158
2160
|
#
|
2159
|
-
#
|
2160
|
-
#
|
2161
|
+
# @option params [required, String] :name
|
2162
|
+
# The name of the policy.
|
2163
|
+
#
|
2164
|
+
# @option params [required, String] :policy_version
|
2165
|
+
# The version of the policy being updated.
|
2161
2166
|
#
|
2162
2167
|
# @option params [String] :description
|
2163
2168
|
# A description of the lifecycle policy.
|
2164
2169
|
#
|
2165
|
-
# @option params [required, String] :name
|
2166
|
-
# The name of the policy.
|
2167
|
-
#
|
2168
2170
|
# @option params [String] :policy
|
2169
2171
|
# The JSON policy document to use as the content for the lifecycle
|
2170
2172
|
# policy.
|
2171
2173
|
#
|
2172
|
-
# @option params [
|
2173
|
-
#
|
2174
|
+
# @option params [String] :client_token
|
2175
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
2176
|
+
# request.
|
2174
2177
|
#
|
2175
|
-
#
|
2176
|
-
#
|
2178
|
+
# **A suitable default value is auto-generated.** You should normally
|
2179
|
+
# not need to pass this option.**
|
2177
2180
|
#
|
2178
2181
|
# @return [Types::UpdateLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2179
2182
|
#
|
@@ -2182,22 +2185,22 @@ module Aws::OpenSearchServerless
|
|
2182
2185
|
# @example Request syntax with placeholder values
|
2183
2186
|
#
|
2184
2187
|
# resp = client.update_lifecycle_policy({
|
2185
|
-
#
|
2186
|
-
# description: "PolicyDescription",
|
2188
|
+
# type: "retention", # required, accepts retention
|
2187
2189
|
# name: "PolicyName", # required
|
2188
|
-
# policy: "PolicyDocument",
|
2189
2190
|
# policy_version: "PolicyVersion", # required
|
2190
|
-
#
|
2191
|
+
# description: "PolicyDescription",
|
2192
|
+
# policy: "PolicyDocument",
|
2193
|
+
# client_token: "ClientToken",
|
2191
2194
|
# })
|
2192
2195
|
#
|
2193
2196
|
# @example Response structure
|
2194
2197
|
#
|
2195
|
-
# resp.lifecycle_policy_detail.
|
2196
|
-
# resp.lifecycle_policy_detail.description #=> String
|
2197
|
-
# resp.lifecycle_policy_detail.last_modified_date #=> Integer
|
2198
|
+
# resp.lifecycle_policy_detail.type #=> String, one of "retention"
|
2198
2199
|
# resp.lifecycle_policy_detail.name #=> String
|
2199
2200
|
# resp.lifecycle_policy_detail.policy_version #=> String
|
2200
|
-
# resp.lifecycle_policy_detail.
|
2201
|
+
# resp.lifecycle_policy_detail.description #=> String
|
2202
|
+
# resp.lifecycle_policy_detail.created_date #=> Integer
|
2203
|
+
# resp.lifecycle_policy_detail.last_modified_date #=> Integer
|
2201
2204
|
#
|
2202
2205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateLifecyclePolicy AWS API Documentation
|
2203
2206
|
#
|
@@ -2216,12 +2219,10 @@ module Aws::OpenSearchServerless
|
|
2216
2219
|
#
|
2217
2220
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html
|
2218
2221
|
#
|
2219
|
-
# @option params [String] :
|
2220
|
-
#
|
2221
|
-
#
|
2222
|
-
#
|
2223
|
-
# **A suitable default value is auto-generated.** You should normally
|
2224
|
-
# not need to pass this option.**
|
2222
|
+
# @option params [required, String] :id
|
2223
|
+
# The security configuration identifier. For SAML the ID will be
|
2224
|
+
# `saml/<accountId>/<idpProviderName>`. For example,
|
2225
|
+
# `saml/123456789123/OKTADev`.
|
2225
2226
|
#
|
2226
2227
|
# @option params [required, String] :config_version
|
2227
2228
|
# The version of the security configuration to be updated. You can find
|
@@ -2231,16 +2232,18 @@ module Aws::OpenSearchServerless
|
|
2231
2232
|
# @option params [String] :description
|
2232
2233
|
# A description of the security configuration.
|
2233
2234
|
#
|
2235
|
+
# @option params [Types::SamlConfigOptions] :saml_options
|
2236
|
+
# SAML options in in the form of a key-value map.
|
2237
|
+
#
|
2234
2238
|
# @option params [Types::UpdateIamIdentityCenterConfigOptions] :iam_identity_center_options_updates
|
2235
2239
|
# Describes IAM Identity Center options in the form of a key-value map.
|
2236
2240
|
#
|
2237
|
-
# @option params [
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
# `saml/123456789123/OKTADev`.
|
2241
|
+
# @option params [String] :client_token
|
2242
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2243
|
+
# request.
|
2241
2244
|
#
|
2242
|
-
#
|
2243
|
-
#
|
2245
|
+
# **A suitable default value is auto-generated.** You should normally
|
2246
|
+
# not need to pass this option.**
|
2244
2247
|
#
|
2245
2248
|
# @return [Types::UpdateSecurityConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2246
2249
|
#
|
@@ -2249,40 +2252,42 @@ module Aws::OpenSearchServerless
|
|
2249
2252
|
# @example Request syntax with placeholder values
|
2250
2253
|
#
|
2251
2254
|
# resp = client.update_security_config({
|
2252
|
-
#
|
2255
|
+
# id: "SecurityConfigId", # required
|
2253
2256
|
# config_version: "PolicyVersion", # required
|
2254
2257
|
# description: "ConfigDescription",
|
2255
|
-
# iam_identity_center_options_updates: {
|
2256
|
-
# group_attribute: "GroupId", # accepts GroupId, GroupName
|
2257
|
-
# user_attribute: "UserId", # accepts UserId, UserName, Email
|
2258
|
-
# },
|
2259
|
-
# id: "SecurityConfigId", # required
|
2260
2258
|
# saml_options: {
|
2261
|
-
# group_attribute: "samlGroupAttribute",
|
2262
2259
|
# metadata: "samlMetadata", # required
|
2263
|
-
# session_timeout: 1,
|
2264
2260
|
# user_attribute: "samlUserAttribute",
|
2261
|
+
# group_attribute: "samlGroupAttribute",
|
2262
|
+
# open_search_serverless_entity_id: "openSearchServerlessEntityId",
|
2263
|
+
# session_timeout: 1,
|
2264
|
+
# },
|
2265
|
+
# iam_identity_center_options_updates: {
|
2266
|
+
# user_attribute: "UserId", # accepts UserId, UserName, Email
|
2267
|
+
# group_attribute: "GroupId", # accepts GroupId, GroupName
|
2265
2268
|
# },
|
2269
|
+
# client_token: "ClientToken",
|
2266
2270
|
# })
|
2267
2271
|
#
|
2268
2272
|
# @example Response structure
|
2269
2273
|
#
|
2274
|
+
# resp.security_config_detail.id #=> String
|
2275
|
+
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
2270
2276
|
# resp.security_config_detail.config_version #=> String
|
2271
|
-
# resp.security_config_detail.created_date #=> Integer
|
2272
2277
|
# resp.security_config_detail.description #=> String
|
2278
|
+
# resp.security_config_detail.saml_options.metadata #=> String
|
2279
|
+
# resp.security_config_detail.saml_options.user_attribute #=> String
|
2280
|
+
# resp.security_config_detail.saml_options.group_attribute #=> String
|
2281
|
+
# resp.security_config_detail.saml_options.open_search_serverless_entity_id #=> String
|
2282
|
+
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
2283
|
+
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
2273
2284
|
# resp.security_config_detail.iam_identity_center_options.application_arn #=> String
|
2274
|
-
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
2275
2285
|
# resp.security_config_detail.iam_identity_center_options.application_name #=> String
|
2276
|
-
# resp.security_config_detail.iam_identity_center_options.
|
2277
|
-
# resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
|
2286
|
+
# resp.security_config_detail.iam_identity_center_options.application_description #=> String
|
2278
2287
|
# resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
|
2279
|
-
# resp.security_config_detail.
|
2288
|
+
# resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
|
2289
|
+
# resp.security_config_detail.created_date #=> Integer
|
2280
2290
|
# resp.security_config_detail.last_modified_date #=> Integer
|
2281
|
-
# resp.security_config_detail.saml_options.group_attribute #=> String
|
2282
|
-
# resp.security_config_detail.saml_options.metadata #=> String
|
2283
|
-
# resp.security_config_detail.saml_options.session_timeout #=> Integer
|
2284
|
-
# resp.security_config_detail.saml_options.user_attribute #=> String
|
2285
|
-
# resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"
|
2286
2291
|
#
|
2287
2292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityConfig AWS API Documentation
|
2288
2293
|
#
|
@@ -2302,28 +2307,28 @@ module Aws::OpenSearchServerless
|
|
2302
2307
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html
|
2303
2308
|
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html
|
2304
2309
|
#
|
2305
|
-
# @option params [String] :
|
2306
|
-
#
|
2307
|
-
# request.
|
2310
|
+
# @option params [required, String] :type
|
2311
|
+
# The type of access policy.
|
2308
2312
|
#
|
2309
|
-
#
|
2310
|
-
#
|
2313
|
+
# @option params [required, String] :name
|
2314
|
+
# The name of the policy.
|
2315
|
+
#
|
2316
|
+
# @option params [required, String] :policy_version
|
2317
|
+
# The version of the policy being updated.
|
2311
2318
|
#
|
2312
2319
|
# @option params [String] :description
|
2313
2320
|
# A description of the policy. Typically used to store information about
|
2314
2321
|
# the permissions defined in the policy.
|
2315
2322
|
#
|
2316
|
-
# @option params [required, String] :name
|
2317
|
-
# The name of the policy.
|
2318
|
-
#
|
2319
2323
|
# @option params [String] :policy
|
2320
2324
|
# The JSON policy document to use as the content for the new policy.
|
2321
2325
|
#
|
2322
|
-
# @option params [
|
2323
|
-
#
|
2326
|
+
# @option params [String] :client_token
|
2327
|
+
# Unique, case-sensitive identifier to ensure idempotency of the
|
2328
|
+
# request.
|
2324
2329
|
#
|
2325
|
-
#
|
2326
|
-
#
|
2330
|
+
# **A suitable default value is auto-generated.** You should normally
|
2331
|
+
# not need to pass this option.**
|
2327
2332
|
#
|
2328
2333
|
# @return [Types::UpdateSecurityPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2329
2334
|
#
|
@@ -2332,22 +2337,22 @@ module Aws::OpenSearchServerless
|
|
2332
2337
|
# @example Request syntax with placeholder values
|
2333
2338
|
#
|
2334
2339
|
# resp = client.update_security_policy({
|
2335
|
-
#
|
2336
|
-
# description: "PolicyDescription",
|
2340
|
+
# type: "encryption", # required, accepts encryption, network
|
2337
2341
|
# name: "PolicyName", # required
|
2338
|
-
# policy: "PolicyDocument",
|
2339
2342
|
# policy_version: "PolicyVersion", # required
|
2340
|
-
#
|
2343
|
+
# description: "PolicyDescription",
|
2344
|
+
# policy: "PolicyDocument",
|
2345
|
+
# client_token: "ClientToken",
|
2341
2346
|
# })
|
2342
2347
|
#
|
2343
2348
|
# @example Response structure
|
2344
2349
|
#
|
2345
|
-
# resp.security_policy_detail.
|
2346
|
-
# resp.security_policy_detail.description #=> String
|
2347
|
-
# resp.security_policy_detail.last_modified_date #=> Integer
|
2350
|
+
# resp.security_policy_detail.type #=> String, one of "encryption", "network"
|
2348
2351
|
# resp.security_policy_detail.name #=> String
|
2349
2352
|
# resp.security_policy_detail.policy_version #=> String
|
2350
|
-
# resp.security_policy_detail.
|
2353
|
+
# resp.security_policy_detail.description #=> String
|
2354
|
+
# resp.security_policy_detail.created_date #=> Integer
|
2355
|
+
# resp.security_policy_detail.last_modified_date #=> Integer
|
2351
2356
|
#
|
2352
2357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateSecurityPolicy AWS API Documentation
|
2353
2358
|
#
|
@@ -2366,13 +2371,23 @@ module Aws::OpenSearchServerless
|
|
2366
2371
|
#
|
2367
2372
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html
|
2368
2373
|
#
|
2374
|
+
# @option params [required, String] :id
|
2375
|
+
# The unique identifier of the interface endpoint to update.
|
2376
|
+
#
|
2377
|
+
# @option params [Array<String>] :add_subnet_ids
|
2378
|
+
# The ID of one or more subnets to add to the endpoint.
|
2379
|
+
#
|
2380
|
+
# @option params [Array<String>] :remove_subnet_ids
|
2381
|
+
# The unique identifiers of the subnets to remove from the endpoint.
|
2382
|
+
#
|
2369
2383
|
# @option params [Array<String>] :add_security_group_ids
|
2370
2384
|
# The unique identifiers of the security groups to add to the endpoint.
|
2371
2385
|
# Security groups define the ports, protocols, and sources for inbound
|
2372
2386
|
# traffic that you are authorizing into your endpoint.
|
2373
2387
|
#
|
2374
|
-
# @option params [Array<String>] :
|
2375
|
-
# The
|
2388
|
+
# @option params [Array<String>] :remove_security_group_ids
|
2389
|
+
# The unique identifiers of the security groups to remove from the
|
2390
|
+
# endpoint.
|
2376
2391
|
#
|
2377
2392
|
# @option params [String] :client_token
|
2378
2393
|
# Unique, case-sensitive identifier to ensure idempotency of the
|
@@ -2381,16 +2396,6 @@ module Aws::OpenSearchServerless
|
|
2381
2396
|
# **A suitable default value is auto-generated.** You should normally
|
2382
2397
|
# not need to pass this option.**
|
2383
2398
|
#
|
2384
|
-
# @option params [required, String] :id
|
2385
|
-
# The unique identifier of the interface endpoint to update.
|
2386
|
-
#
|
2387
|
-
# @option params [Array<String>] :remove_security_group_ids
|
2388
|
-
# The unique identifiers of the security groups to remove from the
|
2389
|
-
# endpoint.
|
2390
|
-
#
|
2391
|
-
# @option params [Array<String>] :remove_subnet_ids
|
2392
|
-
# The unique identifiers of the subnets to remove from the endpoint.
|
2393
|
-
#
|
2394
2399
|
# @return [Types::UpdateVpcEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2395
2400
|
#
|
2396
2401
|
# * {Types::UpdateVpcEndpointResponse#update_vpc_endpoint_detail #update_vpc_endpoint_detail} => Types::UpdateVpcEndpointDetail
|
@@ -2398,24 +2403,24 @@ module Aws::OpenSearchServerless
|
|
2398
2403
|
# @example Request syntax with placeholder values
|
2399
2404
|
#
|
2400
2405
|
# resp = client.update_vpc_endpoint({
|
2401
|
-
# add_security_group_ids: ["SecurityGroupId"],
|
2402
|
-
# add_subnet_ids: ["SubnetId"],
|
2403
|
-
# client_token: "ClientToken",
|
2404
2406
|
# id: "VpcEndpointId", # required
|
2405
|
-
#
|
2407
|
+
# add_subnet_ids: ["SubnetId"],
|
2406
2408
|
# remove_subnet_ids: ["SubnetId"],
|
2409
|
+
# add_security_group_ids: ["SecurityGroupId"],
|
2410
|
+
# remove_security_group_ids: ["SecurityGroupId"],
|
2411
|
+
# client_token: "ClientToken",
|
2407
2412
|
# })
|
2408
2413
|
#
|
2409
2414
|
# @example Response structure
|
2410
2415
|
#
|
2411
2416
|
# resp.update_vpc_endpoint_detail.id #=> String
|
2412
|
-
# resp.update_vpc_endpoint_detail.last_modified_date #=> Integer
|
2413
2417
|
# resp.update_vpc_endpoint_detail.name #=> String
|
2414
|
-
# resp.update_vpc_endpoint_detail.security_group_ids #=> Array
|
2415
|
-
# resp.update_vpc_endpoint_detail.security_group_ids[0] #=> String
|
2416
2418
|
# resp.update_vpc_endpoint_detail.status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"
|
2417
2419
|
# resp.update_vpc_endpoint_detail.subnet_ids #=> Array
|
2418
2420
|
# resp.update_vpc_endpoint_detail.subnet_ids[0] #=> String
|
2421
|
+
# resp.update_vpc_endpoint_detail.security_group_ids #=> Array
|
2422
|
+
# resp.update_vpc_endpoint_detail.security_group_ids[0] #=> String
|
2423
|
+
# resp.update_vpc_endpoint_detail.last_modified_date #=> Integer
|
2419
2424
|
#
|
2420
2425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpoint AWS API Documentation
|
2421
2426
|
#
|
@@ -2444,7 +2449,7 @@ module Aws::OpenSearchServerless
|
|
2444
2449
|
tracer: tracer
|
2445
2450
|
)
|
2446
2451
|
context[:gem_name] = 'aws-sdk-opensearchserverless'
|
2447
|
-
context[:gem_version] = '1.
|
2452
|
+
context[:gem_version] = '1.34.0'
|
2448
2453
|
Seahorse::Client::Request.new(handlers, context)
|
2449
2454
|
end
|
2450
2455
|
|