@aws-sdk/client-opensearchserverless 3.433.0 → 3.436.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/OpenSearchServerless.js +12 -0
  3. package/dist-cjs/commands/BatchGetEffectiveLifecyclePolicyCommand.js +51 -0
  4. package/dist-cjs/commands/BatchGetLifecyclePolicyCommand.js +51 -0
  5. package/dist-cjs/commands/CreateLifecyclePolicyCommand.js +51 -0
  6. package/dist-cjs/commands/DeleteLifecyclePolicyCommand.js +51 -0
  7. package/dist-cjs/commands/ListLifecyclePoliciesCommand.js +51 -0
  8. package/dist-cjs/commands/UpdateLifecyclePolicyCommand.js +51 -0
  9. package/dist-cjs/commands/index.js +6 -0
  10. package/dist-cjs/endpoint/ruleset.js +3 -3
  11. package/dist-cjs/models/models_0.js +7 -1
  12. package/dist-cjs/pagination/ListLifecyclePoliciesPaginator.js +28 -0
  13. package/dist-cjs/pagination/index.js +1 -0
  14. package/dist-cjs/protocols/Aws_json1_0.js +342 -2
  15. package/dist-cjs/runtimeConfig.js +2 -0
  16. package/dist-cjs/runtimeConfig.shared.js +15 -13
  17. package/dist-es/OpenSearchServerless.js +12 -0
  18. package/dist-es/commands/BatchGetEffectiveLifecyclePolicyCommand.js +47 -0
  19. package/dist-es/commands/BatchGetLifecyclePolicyCommand.js +47 -0
  20. package/dist-es/commands/CreateLifecyclePolicyCommand.js +47 -0
  21. package/dist-es/commands/DeleteLifecyclePolicyCommand.js +47 -0
  22. package/dist-es/commands/ListLifecyclePoliciesCommand.js +47 -0
  23. package/dist-es/commands/UpdateLifecyclePolicyCommand.js +47 -0
  24. package/dist-es/commands/index.js +6 -0
  25. package/dist-es/endpoint/ruleset.js +3 -3
  26. package/dist-es/models/models_0.js +6 -0
  27. package/dist-es/pagination/ListLifecyclePoliciesPaginator.js +24 -0
  28. package/dist-es/pagination/index.js +1 -0
  29. package/dist-es/protocols/Aws_json1_0.js +328 -0
  30. package/dist-es/runtimeConfig.js +2 -0
  31. package/dist-es/runtimeConfig.shared.js +15 -13
  32. package/dist-types/OpenSearchServerless.d.ts +42 -0
  33. package/dist-types/OpenSearchServerlessClient.d.ts +8 -2
  34. package/dist-types/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +102 -0
  35. package/dist-types/commands/BatchGetLifecyclePolicyCommand.d.ts +103 -0
  36. package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +101 -0
  37. package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +88 -0
  38. package/dist-types/commands/GetPoliciesStatsCommand.d.ts +3 -0
  39. package/dist-types/commands/ListLifecyclePoliciesCommand.d.ts +95 -0
  40. package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +104 -0
  41. package/dist-types/commands/index.d.ts +6 -0
  42. package/dist-types/models/models_0.d.ts +446 -4
  43. package/dist-types/pagination/ListLifecyclePoliciesPaginator.d.ts +7 -0
  44. package/dist-types/pagination/index.d.ts +1 -0
  45. package/dist-types/protocols/Aws_json1_0.d.ts +54 -0
  46. package/dist-types/ts3.4/OpenSearchServerless.d.ts +102 -0
  47. package/dist-types/ts3.4/OpenSearchServerlessClient.d.ts +36 -0
  48. package/dist-types/ts3.4/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +42 -0
  49. package/dist-types/ts3.4/commands/BatchGetLifecyclePolicyCommand.d.ts +42 -0
  50. package/dist-types/ts3.4/commands/CreateLifecyclePolicyCommand.d.ts +42 -0
  51. package/dist-types/ts3.4/commands/DeleteLifecyclePolicyCommand.d.ts +42 -0
  52. package/dist-types/ts3.4/commands/ListLifecyclePoliciesCommand.d.ts +42 -0
  53. package/dist-types/ts3.4/commands/UpdateLifecyclePolicyCommand.d.ts +42 -0
  54. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  55. package/dist-types/ts3.4/models/models_0.d.ts +109 -0
  56. package/dist-types/ts3.4/pagination/ListLifecyclePoliciesPaginator.d.ts +11 -0
  57. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  58. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +72 -0
  59. package/package.json +4 -3
@@ -0,0 +1,102 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { BatchGetEffectiveLifecyclePolicyRequest, BatchGetEffectiveLifecyclePolicyResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchGetEffectiveLifecyclePolicyCommand}.
14
+ */
15
+ export interface BatchGetEffectiveLifecyclePolicyCommandInput extends BatchGetEffectiveLifecyclePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetEffectiveLifecyclePolicyCommand}.
21
+ */
22
+ export interface BatchGetEffectiveLifecyclePolicyCommandOutput extends BatchGetEffectiveLifecyclePolicyResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { OpenSearchServerlessClient, BatchGetEffectiveLifecyclePolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
31
+ * // const { OpenSearchServerlessClient, BatchGetEffectiveLifecyclePolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
32
+ * const client = new OpenSearchServerlessClient(config);
33
+ * const input = { // BatchGetEffectiveLifecyclePolicyRequest
34
+ * resourceIdentifiers: [ // LifecyclePolicyResourceIdentifiers // required
35
+ * { // LifecyclePolicyResourceIdentifier
36
+ * type: "STRING_VALUE", // required
37
+ * resource: "STRING_VALUE", // required
38
+ * },
39
+ * ],
40
+ * };
41
+ * const command = new BatchGetEffectiveLifecyclePolicyCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // BatchGetEffectiveLifecyclePolicyResponse
44
+ * // effectiveLifecyclePolicyDetails: [ // EffectiveLifecyclePolicyDetails
45
+ * // { // EffectiveLifecyclePolicyDetail
46
+ * // type: "STRING_VALUE",
47
+ * // resource: "STRING_VALUE",
48
+ * // policyName: "STRING_VALUE",
49
+ * // resourceType: "STRING_VALUE",
50
+ * // retentionPeriod: "STRING_VALUE",
51
+ * // noMinRetentionPeriod: true || false,
52
+ * // },
53
+ * // ],
54
+ * // effectiveLifecyclePolicyErrorDetails: [ // EffectiveLifecyclePolicyErrorDetails
55
+ * // { // EffectiveLifecyclePolicyErrorDetail
56
+ * // type: "STRING_VALUE",
57
+ * // resource: "STRING_VALUE",
58
+ * // errorMessage: "STRING_VALUE",
59
+ * // errorCode: "STRING_VALUE",
60
+ * // },
61
+ * // ],
62
+ * // };
63
+ *
64
+ * ```
65
+ *
66
+ * @param BatchGetEffectiveLifecyclePolicyCommandInput - {@link BatchGetEffectiveLifecyclePolicyCommandInput}
67
+ * @returns {@link BatchGetEffectiveLifecyclePolicyCommandOutput}
68
+ * @see {@link BatchGetEffectiveLifecyclePolicyCommandInput} for command's `input` shape.
69
+ * @see {@link BatchGetEffectiveLifecyclePolicyCommandOutput} for command's `response` shape.
70
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
77
+ * input.</p>
78
+ *
79
+ * @throws {@link OpenSearchServerlessServiceException}
80
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
81
+ *
82
+ */
83
+ export declare class BatchGetEffectiveLifecyclePolicyCommand extends $Command<BatchGetEffectiveLifecyclePolicyCommandInput, BatchGetEffectiveLifecyclePolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
84
+ readonly input: BatchGetEffectiveLifecyclePolicyCommandInput;
85
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
89
+ constructor(input: BatchGetEffectiveLifecyclePolicyCommandInput);
90
+ /**
91
+ * @internal
92
+ */
93
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetEffectiveLifecyclePolicyCommandInput, BatchGetEffectiveLifecyclePolicyCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
97
+ private serialize;
98
+ /**
99
+ * @internal
100
+ */
101
+ private deserialize;
102
+ }
@@ -0,0 +1,103 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { BatchGetLifecyclePolicyRequest, BatchGetLifecyclePolicyResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchGetLifecyclePolicyCommand}.
14
+ */
15
+ export interface BatchGetLifecyclePolicyCommandInput extends BatchGetLifecyclePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetLifecyclePolicyCommand}.
21
+ */
22
+ export interface BatchGetLifecyclePolicyCommandOutput extends BatchGetLifecyclePolicyResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { OpenSearchServerlessClient, BatchGetLifecyclePolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
31
+ * // const { OpenSearchServerlessClient, BatchGetLifecyclePolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
32
+ * const client = new OpenSearchServerlessClient(config);
33
+ * const input = { // BatchGetLifecyclePolicyRequest
34
+ * identifiers: [ // LifecyclePolicyIdentifiers // required
35
+ * { // LifecyclePolicyIdentifier
36
+ * type: "STRING_VALUE", // required
37
+ * name: "STRING_VALUE", // required
38
+ * },
39
+ * ],
40
+ * };
41
+ * const command = new BatchGetLifecyclePolicyCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // BatchGetLifecyclePolicyResponse
44
+ * // lifecyclePolicyDetails: [ // LifecyclePolicyDetails
45
+ * // { // LifecyclePolicyDetail
46
+ * // type: "STRING_VALUE",
47
+ * // name: "STRING_VALUE",
48
+ * // policyVersion: "STRING_VALUE",
49
+ * // description: "STRING_VALUE",
50
+ * // policy: "DOCUMENT_VALUE",
51
+ * // createdDate: Number("long"),
52
+ * // lastModifiedDate: Number("long"),
53
+ * // },
54
+ * // ],
55
+ * // lifecyclePolicyErrorDetails: [ // LifecyclePolicyErrorDetails
56
+ * // { // LifecyclePolicyErrorDetail
57
+ * // type: "STRING_VALUE",
58
+ * // name: "STRING_VALUE",
59
+ * // errorMessage: "STRING_VALUE",
60
+ * // errorCode: "STRING_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param BatchGetLifecyclePolicyCommandInput - {@link BatchGetLifecyclePolicyCommandInput}
68
+ * @returns {@link BatchGetLifecyclePolicyCommandOutput}
69
+ * @see {@link BatchGetLifecyclePolicyCommandInput} for command's `input` shape.
70
+ * @see {@link BatchGetLifecyclePolicyCommandOutput} for command's `response` shape.
71
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
75
+ *
76
+ * @throws {@link ValidationException} (client fault)
77
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
78
+ * input.</p>
79
+ *
80
+ * @throws {@link OpenSearchServerlessServiceException}
81
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
82
+ *
83
+ */
84
+ export declare class BatchGetLifecyclePolicyCommand extends $Command<BatchGetLifecyclePolicyCommandInput, BatchGetLifecyclePolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
85
+ readonly input: BatchGetLifecyclePolicyCommandInput;
86
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
90
+ constructor(input: BatchGetLifecyclePolicyCommandInput);
91
+ /**
92
+ * @internal
93
+ */
94
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetLifecyclePolicyCommandInput, BatchGetLifecyclePolicyCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
98
+ private serialize;
99
+ /**
100
+ * @internal
101
+ */
102
+ private deserialize;
103
+ }
@@ -0,0 +1,101 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { CreateLifecyclePolicyRequest, CreateLifecyclePolicyResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateLifecyclePolicyCommand}.
14
+ */
15
+ export interface CreateLifecyclePolicyCommandInput extends CreateLifecyclePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateLifecyclePolicyCommand}.
21
+ */
22
+ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolicyResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define
27
+ * the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create">Creating data lifecycle policies</a>.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { OpenSearchServerlessClient, CreateLifecyclePolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
32
+ * // const { OpenSearchServerlessClient, CreateLifecyclePolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
33
+ * const client = new OpenSearchServerlessClient(config);
34
+ * const input = { // CreateLifecyclePolicyRequest
35
+ * type: "STRING_VALUE", // required
36
+ * name: "STRING_VALUE", // required
37
+ * description: "STRING_VALUE",
38
+ * policy: "STRING_VALUE", // required
39
+ * clientToken: "STRING_VALUE",
40
+ * };
41
+ * const command = new CreateLifecyclePolicyCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // CreateLifecyclePolicyResponse
44
+ * // lifecyclePolicyDetail: { // LifecyclePolicyDetail
45
+ * // type: "STRING_VALUE",
46
+ * // name: "STRING_VALUE",
47
+ * // policyVersion: "STRING_VALUE",
48
+ * // description: "STRING_VALUE",
49
+ * // policy: "DOCUMENT_VALUE",
50
+ * // createdDate: Number("long"),
51
+ * // lastModifiedDate: Number("long"),
52
+ * // },
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param CreateLifecyclePolicyCommandInput - {@link CreateLifecyclePolicyCommandInput}
58
+ * @returns {@link CreateLifecyclePolicyCommandOutput}
59
+ * @see {@link CreateLifecyclePolicyCommandInput} for command's `input` shape.
60
+ * @see {@link CreateLifecyclePolicyCommandOutput} for command's `response` shape.
61
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
62
+ *
63
+ * @throws {@link ConflictException} (client fault)
64
+ * <p>When creating a resource, thrown when a resource with the same name already exists
65
+ * or is being created. When deleting a resource, thrown when the resource is not in
66
+ * the ACTIVE or FAILED state.</p>
67
+ *
68
+ * @throws {@link InternalServerException} (server fault)
69
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
70
+ *
71
+ * @throws {@link ServiceQuotaExceededException} (client fault)
72
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
73
+ *
74
+ * @throws {@link ValidationException} (client fault)
75
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
76
+ * input.</p>
77
+ *
78
+ * @throws {@link OpenSearchServerlessServiceException}
79
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
80
+ *
81
+ */
82
+ export declare class CreateLifecyclePolicyCommand extends $Command<CreateLifecyclePolicyCommandInput, CreateLifecyclePolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
83
+ readonly input: CreateLifecyclePolicyCommandInput;
84
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
88
+ constructor(input: CreateLifecyclePolicyCommandInput);
89
+ /**
90
+ * @internal
91
+ */
92
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLifecyclePolicyCommandInput, CreateLifecyclePolicyCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
96
+ private serialize;
97
+ /**
98
+ * @internal
99
+ */
100
+ private deserialize;
101
+ }
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DeleteLifecyclePolicyRequest, DeleteLifecyclePolicyResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteLifecyclePolicyCommand}.
14
+ */
15
+ export interface DeleteLifecyclePolicyCommandInput extends DeleteLifecyclePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteLifecyclePolicyCommand}.
21
+ */
22
+ export interface DeleteLifecyclePolicyCommandOutput extends DeleteLifecyclePolicyResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes an OpenSearch Serverless lifecycle policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete">Deleting data lifecycle policies</a>.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { OpenSearchServerlessClient, DeleteLifecyclePolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
31
+ * // const { OpenSearchServerlessClient, DeleteLifecyclePolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
32
+ * const client = new OpenSearchServerlessClient(config);
33
+ * const input = { // DeleteLifecyclePolicyRequest
34
+ * type: "STRING_VALUE", // required
35
+ * name: "STRING_VALUE", // required
36
+ * clientToken: "STRING_VALUE",
37
+ * };
38
+ * const command = new DeleteLifecyclePolicyCommand(input);
39
+ * const response = await client.send(command);
40
+ * // {};
41
+ *
42
+ * ```
43
+ *
44
+ * @param DeleteLifecyclePolicyCommandInput - {@link DeleteLifecyclePolicyCommandInput}
45
+ * @returns {@link DeleteLifecyclePolicyCommandOutput}
46
+ * @see {@link DeleteLifecyclePolicyCommandInput} for command's `input` shape.
47
+ * @see {@link DeleteLifecyclePolicyCommandOutput} for command's `response` shape.
48
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
49
+ *
50
+ * @throws {@link ConflictException} (client fault)
51
+ * <p>When creating a resource, thrown when a resource with the same name already exists
52
+ * or is being created. When deleting a resource, thrown when the resource is not in
53
+ * the ACTIVE or FAILED state.</p>
54
+ *
55
+ * @throws {@link InternalServerException} (server fault)
56
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p>Thrown when accessing or deleting a resource that does not exist.</p>
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
63
+ * input.</p>
64
+ *
65
+ * @throws {@link OpenSearchServerlessServiceException}
66
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
67
+ *
68
+ */
69
+ export declare class DeleteLifecyclePolicyCommand extends $Command<DeleteLifecyclePolicyCommandInput, DeleteLifecyclePolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
70
+ readonly input: DeleteLifecyclePolicyCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: DeleteLifecyclePolicyCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteLifecyclePolicyCommandInput, DeleteLifecyclePolicyCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -45,6 +45,9 @@ export interface GetPoliciesStatsCommandOutput extends GetPoliciesStatsResponse,
45
45
  * // SecurityConfigStats: { // SecurityConfigStats
46
46
  * // SamlConfigCount: Number("long"),
47
47
  * // },
48
+ * // LifecyclePolicyStats: { // LifecyclePolicyStats
49
+ * // RetentionPolicyCount: Number("long"),
50
+ * // },
48
51
  * // TotalPolicyCount: Number("long"),
49
52
  * // };
50
53
  *
@@ -0,0 +1,95 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ListLifecyclePoliciesRequest, ListLifecyclePoliciesResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListLifecyclePoliciesCommand}.
14
+ */
15
+ export interface ListLifecyclePoliciesCommandInput extends ListLifecyclePoliciesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListLifecyclePoliciesCommand}.
21
+ */
22
+ export interface ListLifecyclePoliciesCommandOutput extends ListLifecyclePoliciesResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns a list of OpenSearch Serverless lifecycle policies. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { OpenSearchServerlessClient, ListLifecyclePoliciesCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
31
+ * // const { OpenSearchServerlessClient, ListLifecyclePoliciesCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
32
+ * const client = new OpenSearchServerlessClient(config);
33
+ * const input = { // ListLifecyclePoliciesRequest
34
+ * type: "STRING_VALUE", // required
35
+ * resources: [ // LifecycleResourceFilter
36
+ * "STRING_VALUE",
37
+ * ],
38
+ * nextToken: "STRING_VALUE",
39
+ * maxResults: Number("int"),
40
+ * };
41
+ * const command = new ListLifecyclePoliciesCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ListLifecyclePoliciesResponse
44
+ * // lifecyclePolicySummaries: [ // LifecyclePolicySummaries
45
+ * // { // LifecyclePolicySummary
46
+ * // type: "STRING_VALUE",
47
+ * // name: "STRING_VALUE",
48
+ * // policyVersion: "STRING_VALUE",
49
+ * // description: "STRING_VALUE",
50
+ * // createdDate: Number("long"),
51
+ * // lastModifiedDate: Number("long"),
52
+ * // },
53
+ * // ],
54
+ * // nextToken: "STRING_VALUE",
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param ListLifecyclePoliciesCommandInput - {@link ListLifecyclePoliciesCommandInput}
60
+ * @returns {@link ListLifecyclePoliciesCommandOutput}
61
+ * @see {@link ListLifecyclePoliciesCommandInput} for command's `input` shape.
62
+ * @see {@link ListLifecyclePoliciesCommandOutput} for command's `response` shape.
63
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
64
+ *
65
+ * @throws {@link InternalServerException} (server fault)
66
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
67
+ *
68
+ * @throws {@link ValidationException} (client fault)
69
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
70
+ * input.</p>
71
+ *
72
+ * @throws {@link OpenSearchServerlessServiceException}
73
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
74
+ *
75
+ */
76
+ export declare class ListLifecyclePoliciesCommand extends $Command<ListLifecyclePoliciesCommandInput, ListLifecyclePoliciesCommandOutput, OpenSearchServerlessClientResolvedConfig> {
77
+ readonly input: ListLifecyclePoliciesCommandInput;
78
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
82
+ constructor(input: ListLifecyclePoliciesCommandInput);
83
+ /**
84
+ * @internal
85
+ */
86
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListLifecyclePoliciesCommandInput, ListLifecyclePoliciesCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
90
+ private serialize;
91
+ /**
92
+ * @internal
93
+ */
94
+ private deserialize;
95
+ }
@@ -0,0 +1,104 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { UpdateLifecyclePolicyRequest, UpdateLifecyclePolicyResponse } from "../models/models_0";
5
+ import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateLifecyclePolicyCommand}.
14
+ */
15
+ export interface UpdateLifecyclePolicyCommandInput extends UpdateLifecyclePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateLifecyclePolicyCommand}.
21
+ */
22
+ export interface UpdateLifecyclePolicyCommandOutput extends UpdateLifecyclePolicyResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update">Updating data lifecycle policies</a>.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { OpenSearchServerlessClient, UpdateLifecyclePolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
31
+ * // const { OpenSearchServerlessClient, UpdateLifecyclePolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
32
+ * const client = new OpenSearchServerlessClient(config);
33
+ * const input = { // UpdateLifecyclePolicyRequest
34
+ * type: "STRING_VALUE", // required
35
+ * name: "STRING_VALUE", // required
36
+ * policyVersion: "STRING_VALUE", // required
37
+ * description: "STRING_VALUE",
38
+ * policy: "STRING_VALUE",
39
+ * clientToken: "STRING_VALUE",
40
+ * };
41
+ * const command = new UpdateLifecyclePolicyCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // UpdateLifecyclePolicyResponse
44
+ * // lifecyclePolicyDetail: { // LifecyclePolicyDetail
45
+ * // type: "STRING_VALUE",
46
+ * // name: "STRING_VALUE",
47
+ * // policyVersion: "STRING_VALUE",
48
+ * // description: "STRING_VALUE",
49
+ * // policy: "DOCUMENT_VALUE",
50
+ * // createdDate: Number("long"),
51
+ * // lastModifiedDate: Number("long"),
52
+ * // },
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param UpdateLifecyclePolicyCommandInput - {@link UpdateLifecyclePolicyCommandInput}
58
+ * @returns {@link UpdateLifecyclePolicyCommandOutput}
59
+ * @see {@link UpdateLifecyclePolicyCommandInput} for command's `input` shape.
60
+ * @see {@link UpdateLifecyclePolicyCommandOutput} for command's `response` shape.
61
+ * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
62
+ *
63
+ * @throws {@link ConflictException} (client fault)
64
+ * <p>When creating a resource, thrown when a resource with the same name already exists
65
+ * or is being created. When deleting a resource, thrown when the resource is not in
66
+ * the ACTIVE or FAILED state.</p>
67
+ *
68
+ * @throws {@link InternalServerException} (server fault)
69
+ * <p>Thrown when an error internal to the service occurs while processing a request.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>Thrown when accessing or deleting a resource that does not exist.</p>
73
+ *
74
+ * @throws {@link ServiceQuotaExceededException} (client fault)
75
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>Thrown when the HTTP request contains invalid input or is missing required
79
+ * input.</p>
80
+ *
81
+ * @throws {@link OpenSearchServerlessServiceException}
82
+ * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
83
+ *
84
+ */
85
+ export declare class UpdateLifecyclePolicyCommand extends $Command<UpdateLifecyclePolicyCommandInput, UpdateLifecyclePolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
86
+ readonly input: UpdateLifecyclePolicyCommandInput;
87
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
91
+ constructor(input: UpdateLifecyclePolicyCommandInput);
92
+ /**
93
+ * @internal
94
+ */
95
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLifecyclePolicyCommandInput, UpdateLifecyclePolicyCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
99
+ private serialize;
100
+ /**
101
+ * @internal
102
+ */
103
+ private deserialize;
104
+ }
@@ -1,12 +1,16 @@
1
1
  export * from "./BatchGetCollectionCommand";
2
+ export * from "./BatchGetEffectiveLifecyclePolicyCommand";
3
+ export * from "./BatchGetLifecyclePolicyCommand";
2
4
  export * from "./BatchGetVpcEndpointCommand";
3
5
  export * from "./CreateAccessPolicyCommand";
4
6
  export * from "./CreateCollectionCommand";
7
+ export * from "./CreateLifecyclePolicyCommand";
5
8
  export * from "./CreateSecurityConfigCommand";
6
9
  export * from "./CreateSecurityPolicyCommand";
7
10
  export * from "./CreateVpcEndpointCommand";
8
11
  export * from "./DeleteAccessPolicyCommand";
9
12
  export * from "./DeleteCollectionCommand";
13
+ export * from "./DeleteLifecyclePolicyCommand";
10
14
  export * from "./DeleteSecurityConfigCommand";
11
15
  export * from "./DeleteSecurityPolicyCommand";
12
16
  export * from "./DeleteVpcEndpointCommand";
@@ -17,6 +21,7 @@ export * from "./GetSecurityConfigCommand";
17
21
  export * from "./GetSecurityPolicyCommand";
18
22
  export * from "./ListAccessPoliciesCommand";
19
23
  export * from "./ListCollectionsCommand";
24
+ export * from "./ListLifecyclePoliciesCommand";
20
25
  export * from "./ListSecurityConfigsCommand";
21
26
  export * from "./ListSecurityPoliciesCommand";
22
27
  export * from "./ListTagsForResourceCommand";
@@ -26,6 +31,7 @@ export * from "./UntagResourceCommand";
26
31
  export * from "./UpdateAccessPolicyCommand";
27
32
  export * from "./UpdateAccountSettingsCommand";
28
33
  export * from "./UpdateCollectionCommand";
34
+ export * from "./UpdateLifecyclePolicyCommand";
29
35
  export * from "./UpdateSecurityConfigCommand";
30
36
  export * from "./UpdateSecurityPolicyCommand";
31
37
  export * from "./UpdateVpcEndpointCommand";