aws-sdk-opensearchserverless 1.9.0 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1880acf0bac5a7c01dd2301ceaa94c529087853200798960481f97c4004a9be8
4
- data.tar.gz: 189232de62a53a4da288457cca125429ff87904228d8d92c93ff42b411f562cf
3
+ metadata.gz: 4d225ca149fc195aadabf5de83a0a090a46b0c87a47df66696dab46bddbd00d6
4
+ data.tar.gz: 96ff8448f41930f38cc360274eb71897e9192857713b46adebdd68054060eb98
5
5
  SHA512:
6
- metadata.gz: 9af17a8a01f72012674c22c2a76f00be90bc03db7b2c4d0c9fadf8169efc0ac5e1538c9ceaa06f10ae1df81a67f305ce227f58e072a6771db7a81e1152dae08b
7
- data.tar.gz: 4337188337fe899a8a2737f6ffe9b6ba45b12ba961c04c19a0f852d05d84df94b1739f2c94a5bee8d457cf15177d9ebd064035f72f64bf14dd76871d48b1c166
6
+ metadata.gz: 2232b3c0210d8dabd301cb8740ad326f7cd78a3d3d661e72eb93b3e5388c68896d66cf144be54fff9cf9f0b8c31c4bbd12db0d0eb82d181186c48c23328c3271
7
+ data.tar.gz: fc791b0f7a7056e68be1f0603b9b6c86f1772151bcc9d73201def48564d946332f2313088c116d196988627c9321a68d710c28c05faa30ce9f2ddbc8db511688
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.11.0 (2023-10-24)
5
+ ------------------
6
+
7
+ * Feature - This release includes the following new APIs: CreateLifecyclePolicy, UpdateLifecyclePolicy, BatchGetLifecyclePolicy, DeleteLifecyclePolicy, ListLifecyclePolicies and BatchGetEffectiveLifecyclePolicy to support the data lifecycle management feature.
8
+
9
+ 1.10.0 (2023-09-27)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.9.0 (2023-09-19)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.9.0
1
+ 1.11.0
@@ -461,6 +461,108 @@ module Aws::OpenSearchServerless
461
461
  req.send_request(options)
462
462
  end
463
463
 
464
+ # Returns a list of successful and failed retrievals for the OpenSearch
465
+ # Serverless indexes. For more information, see [Viewing data lifecycle
466
+ # policies][1].
467
+ #
468
+ #
469
+ #
470
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list
471
+ #
472
+ # @option params [required, Array<Types::LifecyclePolicyResourceIdentifier>] :resource_identifiers
473
+ # The unique identifiers of policy types and resource names.
474
+ #
475
+ # @return [Types::BatchGetEffectiveLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
476
+ #
477
+ # * {Types::BatchGetEffectiveLifecyclePolicyResponse#effective_lifecycle_policy_details #effective_lifecycle_policy_details} => Array&lt;Types::EffectiveLifecyclePolicyDetail&gt;
478
+ # * {Types::BatchGetEffectiveLifecyclePolicyResponse#effective_lifecycle_policy_error_details #effective_lifecycle_policy_error_details} => Array&lt;Types::EffectiveLifecyclePolicyErrorDetail&gt;
479
+ #
480
+ # @example Request syntax with placeholder values
481
+ #
482
+ # resp = client.batch_get_effective_lifecycle_policy({
483
+ # resource_identifiers: [ # required
484
+ # {
485
+ # resource: "ResourceName", # required
486
+ # type: "retention", # required, accepts retention
487
+ # },
488
+ # ],
489
+ # })
490
+ #
491
+ # @example Response structure
492
+ #
493
+ # resp.effective_lifecycle_policy_details #=> Array
494
+ # resp.effective_lifecycle_policy_details[0].no_min_retention_period #=> Boolean
495
+ # resp.effective_lifecycle_policy_details[0].policy_name #=> String
496
+ # resp.effective_lifecycle_policy_details[0].resource #=> String
497
+ # resp.effective_lifecycle_policy_details[0].resource_type #=> String, one of "index"
498
+ # resp.effective_lifecycle_policy_details[0].retention_period #=> String
499
+ # resp.effective_lifecycle_policy_details[0].type #=> String, one of "retention"
500
+ # resp.effective_lifecycle_policy_error_details #=> Array
501
+ # resp.effective_lifecycle_policy_error_details[0].error_code #=> String
502
+ # resp.effective_lifecycle_policy_error_details[0].error_message #=> String
503
+ # resp.effective_lifecycle_policy_error_details[0].resource #=> String
504
+ # resp.effective_lifecycle_policy_error_details[0].type #=> String, one of "retention"
505
+ #
506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetEffectiveLifecyclePolicy AWS API Documentation
507
+ #
508
+ # @overload batch_get_effective_lifecycle_policy(params = {})
509
+ # @param [Hash] params ({})
510
+ def batch_get_effective_lifecycle_policy(params = {}, options = {})
511
+ req = build_request(:batch_get_effective_lifecycle_policy, params)
512
+ req.send_request(options)
513
+ end
514
+
515
+ # Returns one or more configured OpenSearch Serverless lifecycle
516
+ # policies. For more information, see [Viewing data lifecycle
517
+ # policies][1].
518
+ #
519
+ #
520
+ #
521
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list
522
+ #
523
+ # @option params [required, Array<Types::LifecyclePolicyIdentifier>] :identifiers
524
+ # The unique identifiers of policy types and policy names.
525
+ #
526
+ # @return [Types::BatchGetLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
+ #
528
+ # * {Types::BatchGetLifecyclePolicyResponse#lifecycle_policy_details #lifecycle_policy_details} => Array&lt;Types::LifecyclePolicyDetail&gt;
529
+ # * {Types::BatchGetLifecyclePolicyResponse#lifecycle_policy_error_details #lifecycle_policy_error_details} => Array&lt;Types::LifecyclePolicyErrorDetail&gt;
530
+ #
531
+ # @example Request syntax with placeholder values
532
+ #
533
+ # resp = client.batch_get_lifecycle_policy({
534
+ # identifiers: [ # required
535
+ # {
536
+ # name: "PolicyName", # required
537
+ # type: "retention", # required, accepts retention
538
+ # },
539
+ # ],
540
+ # })
541
+ #
542
+ # @example Response structure
543
+ #
544
+ # resp.lifecycle_policy_details #=> Array
545
+ # resp.lifecycle_policy_details[0].created_date #=> Integer
546
+ # resp.lifecycle_policy_details[0].description #=> String
547
+ # resp.lifecycle_policy_details[0].last_modified_date #=> Integer
548
+ # resp.lifecycle_policy_details[0].name #=> String
549
+ # resp.lifecycle_policy_details[0].policy_version #=> String
550
+ # resp.lifecycle_policy_details[0].type #=> String, one of "retention"
551
+ # resp.lifecycle_policy_error_details #=> Array
552
+ # resp.lifecycle_policy_error_details[0].error_code #=> String
553
+ # resp.lifecycle_policy_error_details[0].error_message #=> String
554
+ # resp.lifecycle_policy_error_details[0].name #=> String
555
+ # resp.lifecycle_policy_error_details[0].type #=> String, one of "retention"
556
+ #
557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/BatchGetLifecyclePolicy AWS API Documentation
558
+ #
559
+ # @overload batch_get_lifecycle_policy(params = {})
560
+ # @param [Hash] params ({})
561
+ def batch_get_lifecycle_policy(params = {}, options = {})
562
+ req = build_request(:batch_get_lifecycle_policy, params)
563
+ req.send_request(options)
564
+ end
565
+
464
566
  # Returns attributes for one or more VPC endpoints associated with the
465
567
  # current account. For more information, see [Access Amazon OpenSearch
466
568
  # Serverless using an interface endpoint][1].
@@ -639,6 +741,67 @@ module Aws::OpenSearchServerless
639
741
  req.send_request(options)
640
742
  end
641
743
 
744
+ # Creates a lifecyle policy to be applied to OpenSearch Serverless
745
+ # indexes. Lifecycle policies define the number of days or hours to
746
+ # retain the data on an OpenSearch Serverless index. For more
747
+ # information, see [Creating data lifecycle policies][1].
748
+ #
749
+ #
750
+ #
751
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create
752
+ #
753
+ # @option params [String] :client_token
754
+ # A unique, case-sensitive identifier to ensure idempotency of the
755
+ # request.
756
+ #
757
+ # **A suitable default value is auto-generated.** You should normally
758
+ # not need to pass this option.**
759
+ #
760
+ # @option params [String] :description
761
+ # A description of the lifecycle policy.
762
+ #
763
+ # @option params [required, String] :name
764
+ # The name of the lifecycle policy.
765
+ #
766
+ # @option params [required, String] :policy
767
+ # The JSON policy document to use as the content for the lifecycle
768
+ # policy.
769
+ #
770
+ # @option params [required, String] :type
771
+ # The type of lifecycle policy.
772
+ #
773
+ # @return [Types::CreateLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
774
+ #
775
+ # * {Types::CreateLifecyclePolicyResponse#lifecycle_policy_detail #lifecycle_policy_detail} => Types::LifecyclePolicyDetail
776
+ #
777
+ # @example Request syntax with placeholder values
778
+ #
779
+ # resp = client.create_lifecycle_policy({
780
+ # client_token: "ClientToken",
781
+ # description: "PolicyDescription",
782
+ # name: "PolicyName", # required
783
+ # policy: "PolicyDocument", # required
784
+ # type: "retention", # required, accepts retention
785
+ # })
786
+ #
787
+ # @example Response structure
788
+ #
789
+ # resp.lifecycle_policy_detail.created_date #=> Integer
790
+ # resp.lifecycle_policy_detail.description #=> String
791
+ # resp.lifecycle_policy_detail.last_modified_date #=> Integer
792
+ # resp.lifecycle_policy_detail.name #=> String
793
+ # resp.lifecycle_policy_detail.policy_version #=> String
794
+ # resp.lifecycle_policy_detail.type #=> String, one of "retention"
795
+ #
796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/CreateLifecyclePolicy AWS API Documentation
797
+ #
798
+ # @overload create_lifecycle_policy(params = {})
799
+ # @param [Hash] params ({})
800
+ def create_lifecycle_policy(params = {}, options = {})
801
+ req = build_request(:create_lifecycle_policy, params)
802
+ req.send_request(options)
803
+ end
804
+
642
805
  # Specifies a security configuration for OpenSearch Serverless. For more
643
806
  # information, see [SAML authentication for Amazon OpenSearch
644
807
  # Serverless][1].
@@ -920,6 +1083,45 @@ module Aws::OpenSearchServerless
920
1083
  req.send_request(options)
921
1084
  end
922
1085
 
1086
+ # Deletes an OpenSearch Serverless lifecycle policy. For more
1087
+ # information, see [Deleting data lifecycle policies][1].
1088
+ #
1089
+ #
1090
+ #
1091
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete
1092
+ #
1093
+ # @option params [String] :client_token
1094
+ # Unique, case-sensitive identifier to ensure idempotency of the
1095
+ # request.
1096
+ #
1097
+ # **A suitable default value is auto-generated.** You should normally
1098
+ # not need to pass this option.**
1099
+ #
1100
+ # @option params [required, String] :name
1101
+ # The name of the policy to delete.
1102
+ #
1103
+ # @option params [required, String] :type
1104
+ # The type of lifecycle policy.
1105
+ #
1106
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1107
+ #
1108
+ # @example Request syntax with placeholder values
1109
+ #
1110
+ # resp = client.delete_lifecycle_policy({
1111
+ # client_token: "ClientToken",
1112
+ # name: "PolicyName", # required
1113
+ # type: "retention", # required, accepts retention
1114
+ # })
1115
+ #
1116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/DeleteLifecyclePolicy AWS API Documentation
1117
+ #
1118
+ # @overload delete_lifecycle_policy(params = {})
1119
+ # @param [Hash] params ({})
1120
+ def delete_lifecycle_policy(params = {}, options = {})
1121
+ req = build_request(:delete_lifecycle_policy, params)
1122
+ req.send_request(options)
1123
+ end
1124
+
923
1125
  # Deletes a security configuration for OpenSearch Serverless. For more
924
1126
  # information, see [SAML authentication for Amazon OpenSearch
925
1127
  # Serverless][1].
@@ -1047,7 +1249,7 @@ module Aws::OpenSearchServerless
1047
1249
  # The name of the access policy.
1048
1250
  #
1049
1251
  # @option params [required, String] :type
1050
- # Tye type of policy. Currently the only supported value is `data`.
1252
+ # Tye type of policy. Currently, the only supported value is `data`.
1051
1253
  #
1052
1254
  # @return [Types::GetAccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1053
1255
  #
@@ -1104,6 +1306,7 @@ module Aws::OpenSearchServerless
1104
1306
  # @return [Types::GetPoliciesStatsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
1307
  #
1106
1308
  # * {Types::GetPoliciesStatsResponse#access_policy_stats #access_policy_stats} => Types::AccessPolicyStats
1309
+ # * {Types::GetPoliciesStatsResponse#lifecycle_policy_stats #lifecycle_policy_stats} => Types::LifecyclePolicyStats
1107
1310
  # * {Types::GetPoliciesStatsResponse#security_config_stats #security_config_stats} => Types::SecurityConfigStats
1108
1311
  # * {Types::GetPoliciesStatsResponse#security_policy_stats #security_policy_stats} => Types::SecurityPolicyStats
1109
1312
  # * {Types::GetPoliciesStatsResponse#total_policy_count #total_policy_count} => Integer
@@ -1111,6 +1314,7 @@ module Aws::OpenSearchServerless
1111
1314
  # @example Response structure
1112
1315
  #
1113
1316
  # resp.access_policy_stats.data_policy_count #=> Integer
1317
+ # resp.lifecycle_policy_stats.retention_policy_count #=> Integer
1114
1318
  # resp.security_config_stats.saml_config_count #=> Integer
1115
1319
  # resp.security_policy_stats.encryption_policy_count #=> Integer
1116
1320
  # resp.security_policy_stats.network_policy_count #=> Integer
@@ -1283,7 +1487,7 @@ module Aws::OpenSearchServerless
1283
1487
  # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html
1284
1488
  #
1285
1489
  # @option params [Types::CollectionFilters] :collection_filters
1286
- # List of filter names and values that you can use for requests.
1490
+ # A list of filter names and values that you can use for requests.
1287
1491
  #
1288
1492
  # @option params [Integer] :max_results
1289
1493
  # The maximum number of results to return. Default is 20. You can use
@@ -1330,6 +1534,67 @@ module Aws::OpenSearchServerless
1330
1534
  req.send_request(options)
1331
1535
  end
1332
1536
 
1537
+ # Returns a list of OpenSearch Serverless lifecycle policies. For more
1538
+ # information, see [Viewing data lifecycle policies][1].
1539
+ #
1540
+ #
1541
+ #
1542
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list
1543
+ #
1544
+ # @option params [Integer] :max_results
1545
+ # An optional parameter that specifies the maximum number of results to
1546
+ # return. You can use use `nextToken` to get the next page of results.
1547
+ # The default is 10.
1548
+ #
1549
+ # @option params [String] :next_token
1550
+ # If your initial `ListLifecyclePolicies` operation returns a
1551
+ # `nextToken`, you can include the returned `nextToken` in subsequent
1552
+ # `ListLifecyclePolicies` operations, which returns results in the next
1553
+ # page.
1554
+ #
1555
+ # @option params [Array<String>] :resources
1556
+ # Resource filters that policies can apply to. Currently, the only
1557
+ # supported resource type is `index`.
1558
+ #
1559
+ # @option params [required, String] :type
1560
+ # The type of lifecycle policy.
1561
+ #
1562
+ # @return [Types::ListLifecyclePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1563
+ #
1564
+ # * {Types::ListLifecyclePoliciesResponse#lifecycle_policy_summaries #lifecycle_policy_summaries} => Array&lt;Types::LifecyclePolicySummary&gt;
1565
+ # * {Types::ListLifecyclePoliciesResponse#next_token #next_token} => String
1566
+ #
1567
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1568
+ #
1569
+ # @example Request syntax with placeholder values
1570
+ #
1571
+ # resp = client.list_lifecycle_policies({
1572
+ # max_results: 1,
1573
+ # next_token: "String",
1574
+ # resources: ["LifecycleResource"],
1575
+ # type: "retention", # required, accepts retention
1576
+ # })
1577
+ #
1578
+ # @example Response structure
1579
+ #
1580
+ # resp.lifecycle_policy_summaries #=> Array
1581
+ # resp.lifecycle_policy_summaries[0].created_date #=> Integer
1582
+ # resp.lifecycle_policy_summaries[0].description #=> String
1583
+ # resp.lifecycle_policy_summaries[0].last_modified_date #=> Integer
1584
+ # resp.lifecycle_policy_summaries[0].name #=> String
1585
+ # resp.lifecycle_policy_summaries[0].policy_version #=> String
1586
+ # resp.lifecycle_policy_summaries[0].type #=> String, one of "retention"
1587
+ # resp.next_token #=> String
1588
+ #
1589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/ListLifecyclePolicies AWS API Documentation
1590
+ #
1591
+ # @overload list_lifecycle_policies(params = {})
1592
+ # @param [Hash] params ({})
1593
+ def list_lifecycle_policies(params = {}, options = {})
1594
+ req = build_request(:list_lifecycle_policies, params)
1595
+ req.send_request(options)
1596
+ end
1597
+
1333
1598
  # Returns information about configured OpenSearch Serverless security
1334
1599
  # configurations. For more information, see [SAML authentication for
1335
1600
  # Amazon OpenSearch Serverless][1].
@@ -1769,6 +2034,69 @@ module Aws::OpenSearchServerless
1769
2034
  req.send_request(options)
1770
2035
  end
1771
2036
 
2037
+ # Updates an OpenSearch Serverless access policy. For more information,
2038
+ # see [Updating data lifecycle policies][1].
2039
+ #
2040
+ #
2041
+ #
2042
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update
2043
+ #
2044
+ # @option params [String] :client_token
2045
+ # A unique, case-sensitive identifier to ensure idempotency of the
2046
+ # request.
2047
+ #
2048
+ # **A suitable default value is auto-generated.** You should normally
2049
+ # not need to pass this option.**
2050
+ #
2051
+ # @option params [String] :description
2052
+ # A description of the lifecycle policy.
2053
+ #
2054
+ # @option params [required, String] :name
2055
+ # The name of the policy.
2056
+ #
2057
+ # @option params [String] :policy
2058
+ # The JSON policy document to use as the content for the lifecycle
2059
+ # policy.
2060
+ #
2061
+ # @option params [required, String] :policy_version
2062
+ # The version of the policy being updated.
2063
+ #
2064
+ # @option params [required, String] :type
2065
+ # The type of lifecycle policy.
2066
+ #
2067
+ # @return [Types::UpdateLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2068
+ #
2069
+ # * {Types::UpdateLifecyclePolicyResponse#lifecycle_policy_detail #lifecycle_policy_detail} => Types::LifecyclePolicyDetail
2070
+ #
2071
+ # @example Request syntax with placeholder values
2072
+ #
2073
+ # resp = client.update_lifecycle_policy({
2074
+ # client_token: "ClientToken",
2075
+ # description: "PolicyDescription",
2076
+ # name: "PolicyName", # required
2077
+ # policy: "PolicyDocument",
2078
+ # policy_version: "PolicyVersion", # required
2079
+ # type: "retention", # required, accepts retention
2080
+ # })
2081
+ #
2082
+ # @example Response structure
2083
+ #
2084
+ # resp.lifecycle_policy_detail.created_date #=> Integer
2085
+ # resp.lifecycle_policy_detail.description #=> String
2086
+ # resp.lifecycle_policy_detail.last_modified_date #=> Integer
2087
+ # resp.lifecycle_policy_detail.name #=> String
2088
+ # resp.lifecycle_policy_detail.policy_version #=> String
2089
+ # resp.lifecycle_policy_detail.type #=> String, one of "retention"
2090
+ #
2091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateLifecyclePolicy AWS API Documentation
2092
+ #
2093
+ # @overload update_lifecycle_policy(params = {})
2094
+ # @param [Hash] params ({})
2095
+ def update_lifecycle_policy(params = {}, options = {})
2096
+ req = build_request(:update_lifecycle_policy, params)
2097
+ req.send_request(options)
2098
+ end
2099
+
1772
2100
  # Updates a security configuration for OpenSearch Serverless. For more
1773
2101
  # information, see [SAML authentication for Amazon OpenSearch
1774
2102
  # Serverless][1].
@@ -1987,7 +2315,7 @@ module Aws::OpenSearchServerless
1987
2315
  params: params,
1988
2316
  config: config)
1989
2317
  context[:gem_name] = 'aws-sdk-opensearchserverless'
1990
- context[:gem_version] = '1.9.0'
2318
+ context[:gem_version] = '1.11.0'
1991
2319
  Seahorse::Client::Request.new(handlers, context)
1992
2320
  end
1993
2321