@aws-sdk/client-opensearchserverless 3.296.0 → 3.298.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 (107) hide show
  1. package/dist-cjs/commands/BatchGetCollectionCommand.js +2 -3
  2. package/dist-cjs/commands/BatchGetVpcEndpointCommand.js +2 -3
  3. package/dist-cjs/commands/CreateAccessPolicyCommand.js +2 -3
  4. package/dist-cjs/commands/CreateCollectionCommand.js +2 -3
  5. package/dist-cjs/commands/CreateSecurityConfigCommand.js +2 -3
  6. package/dist-cjs/commands/CreateSecurityPolicyCommand.js +2 -3
  7. package/dist-cjs/commands/CreateVpcEndpointCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteAccessPolicyCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteCollectionCommand.js +2 -3
  10. package/dist-cjs/commands/DeleteSecurityConfigCommand.js +2 -3
  11. package/dist-cjs/commands/DeleteSecurityPolicyCommand.js +2 -3
  12. package/dist-cjs/commands/DeleteVpcEndpointCommand.js +2 -3
  13. package/dist-cjs/commands/GetAccessPolicyCommand.js +2 -3
  14. package/dist-cjs/commands/GetAccountSettingsCommand.js +2 -3
  15. package/dist-cjs/commands/GetPoliciesStatsCommand.js +2 -3
  16. package/dist-cjs/commands/GetSecurityConfigCommand.js +2 -3
  17. package/dist-cjs/commands/GetSecurityPolicyCommand.js +2 -3
  18. package/dist-cjs/commands/ListAccessPoliciesCommand.js +2 -3
  19. package/dist-cjs/commands/ListCollectionsCommand.js +2 -3
  20. package/dist-cjs/commands/ListSecurityConfigsCommand.js +2 -3
  21. package/dist-cjs/commands/ListSecurityPoliciesCommand.js +2 -3
  22. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  23. package/dist-cjs/commands/ListVpcEndpointsCommand.js +2 -3
  24. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  25. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  26. package/dist-cjs/commands/UpdateAccessPolicyCommand.js +2 -3
  27. package/dist-cjs/commands/UpdateAccountSettingsCommand.js +2 -3
  28. package/dist-cjs/commands/UpdateCollectionCommand.js +2 -3
  29. package/dist-cjs/commands/UpdateSecurityConfigCommand.js +2 -3
  30. package/dist-cjs/commands/UpdateSecurityPolicyCommand.js +2 -3
  31. package/dist-cjs/commands/UpdateVpcEndpointCommand.js +2 -3
  32. package/dist-cjs/models/models_0.js +1 -358
  33. package/dist-es/commands/BatchGetCollectionCommand.js +2 -3
  34. package/dist-es/commands/BatchGetVpcEndpointCommand.js +2 -3
  35. package/dist-es/commands/CreateAccessPolicyCommand.js +2 -3
  36. package/dist-es/commands/CreateCollectionCommand.js +2 -3
  37. package/dist-es/commands/CreateSecurityConfigCommand.js +2 -3
  38. package/dist-es/commands/CreateSecurityPolicyCommand.js +2 -3
  39. package/dist-es/commands/CreateVpcEndpointCommand.js +2 -3
  40. package/dist-es/commands/DeleteAccessPolicyCommand.js +2 -3
  41. package/dist-es/commands/DeleteCollectionCommand.js +2 -3
  42. package/dist-es/commands/DeleteSecurityConfigCommand.js +2 -3
  43. package/dist-es/commands/DeleteSecurityPolicyCommand.js +2 -3
  44. package/dist-es/commands/DeleteVpcEndpointCommand.js +2 -3
  45. package/dist-es/commands/GetAccessPolicyCommand.js +2 -3
  46. package/dist-es/commands/GetAccountSettingsCommand.js +2 -3
  47. package/dist-es/commands/GetPoliciesStatsCommand.js +2 -3
  48. package/dist-es/commands/GetSecurityConfigCommand.js +2 -3
  49. package/dist-es/commands/GetSecurityPolicyCommand.js +2 -3
  50. package/dist-es/commands/ListAccessPoliciesCommand.js +2 -3
  51. package/dist-es/commands/ListCollectionsCommand.js +2 -3
  52. package/dist-es/commands/ListSecurityConfigsCommand.js +2 -3
  53. package/dist-es/commands/ListSecurityPoliciesCommand.js +2 -3
  54. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  55. package/dist-es/commands/ListVpcEndpointsCommand.js +2 -3
  56. package/dist-es/commands/TagResourceCommand.js +2 -3
  57. package/dist-es/commands/UntagResourceCommand.js +2 -3
  58. package/dist-es/commands/UpdateAccessPolicyCommand.js +2 -3
  59. package/dist-es/commands/UpdateAccountSettingsCommand.js +2 -3
  60. package/dist-es/commands/UpdateCollectionCommand.js +2 -3
  61. package/dist-es/commands/UpdateSecurityConfigCommand.js +2 -3
  62. package/dist-es/commands/UpdateSecurityPolicyCommand.js +2 -3
  63. package/dist-es/commands/UpdateVpcEndpointCommand.js +2 -3
  64. package/dist-es/models/models_0.js +0 -267
  65. package/dist-types/OpenSearchServerless.d.ts +33 -1
  66. package/dist-types/OpenSearchServerlessClient.d.ts +24 -4
  67. package/dist-types/commands/BatchGetCollectionCommand.d.ts +16 -0
  68. package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +16 -0
  69. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +16 -0
  70. package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
  71. package/dist-types/commands/CreateSecurityConfigCommand.d.ts +16 -0
  72. package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +16 -0
  73. package/dist-types/commands/CreateVpcEndpointCommand.d.ts +16 -0
  74. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +16 -0
  75. package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
  76. package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +16 -0
  77. package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +16 -0
  78. package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +16 -0
  79. package/dist-types/commands/GetAccessPolicyCommand.d.ts +16 -0
  80. package/dist-types/commands/GetAccountSettingsCommand.d.ts +16 -0
  81. package/dist-types/commands/GetPoliciesStatsCommand.d.ts +16 -0
  82. package/dist-types/commands/GetSecurityConfigCommand.d.ts +16 -0
  83. package/dist-types/commands/GetSecurityPolicyCommand.d.ts +16 -0
  84. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +16 -0
  85. package/dist-types/commands/ListCollectionsCommand.d.ts +17 -1
  86. package/dist-types/commands/ListSecurityConfigsCommand.d.ts +16 -0
  87. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +16 -0
  88. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  89. package/dist-types/commands/ListVpcEndpointsCommand.d.ts +16 -0
  90. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  91. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateCollectionCommand.d.ts +16 -0
  95. package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +16 -0
  97. package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +16 -0
  98. package/dist-types/models/OpenSearchServerlessServiceException.d.ts +2 -0
  99. package/dist-types/models/models_0.d.ts +235 -356
  100. package/dist-types/pagination/Interfaces.d.ts +3 -0
  101. package/dist-types/pagination/ListAccessPoliciesPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/ListSecurityConfigsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/ListSecurityPoliciesPaginator.d.ts +3 -0
  105. package/dist-types/pagination/ListVpcEndpointsPaginator.d.ts +3 -0
  106. package/dist-types/ts3.4/models/models_0.d.ts +0 -265
  107. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateVpcEndpointRequest, CreateVpcEndpointResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateVpcEndpointCommand}.
8
10
  */
9
11
  export interface CreateVpcEndpointCommandInput extends CreateVpcEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateVpcEndpointCommand}.
13
17
  */
14
18
  export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
18
23
  * Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateVpcEndpointCommandInput - {@link CreateVpcEndpointCommandInput}
35
+ * @returns {@link CreateVpcEndpointCommandOutput}
29
36
  * @see {@link CreateVpcEndpointCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateVpcEndpointCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointRespons
47
54
  export declare class CreateVpcEndpointCommand extends $Command<CreateVpcEndpointCommandInput, CreateVpcEndpointCommandOutput, OpenSearchServerlessClientResolvedConfig> {
48
55
  readonly input: CreateVpcEndpointCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreateVpcEndpointCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateVpcEndpointCommandInput, CreateVpcEndpointCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteAccessPolicyRequest, DeleteAccessPolicyResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAccessPolicyCommand}.
8
10
  */
9
11
  export interface DeleteAccessPolicyCommandInput extends DeleteAccessPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAccessPolicyCommand}.
13
17
  */
14
18
  export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
18
23
  * access control for Amazon OpenSearch Serverless</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteAccessPolicyCommandInput - {@link DeleteAccessPolicyCommandInput}
35
+ * @returns {@link DeleteAccessPolicyCommandOutput}
29
36
  * @see {@link DeleteAccessPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteAccessPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
50
57
  export declare class DeleteAccessPolicyCommand extends $Command<DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
51
58
  readonly input: DeleteAccessPolicyCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteAccessPolicyCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteCollectionRequest, DeleteCollectionResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCollectionCommand}.
8
10
  */
9
11
  export interface DeleteCollectionCommandInput extends DeleteCollectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCollectionCommand}.
13
17
  */
14
18
  export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
18
23
  * managing Amazon OpenSearch Serverless collections</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteCollectionCommandInput - {@link DeleteCollectionCommandInput}
35
+ * @returns {@link DeleteCollectionCommandOutput}
29
36
  * @see {@link DeleteCollectionCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
50
57
  export declare class DeleteCollectionCommand extends $Command<DeleteCollectionCommandInput, DeleteCollectionCommandOutput, OpenSearchServerlessClientResolvedConfig> {
51
58
  readonly input: DeleteCollectionCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteCollectionCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCollectionCommandInput, DeleteCollectionCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSecurityConfigRequest, DeleteSecurityConfigResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSecurityConfigCommand}.
8
10
  */
9
11
  export interface DeleteSecurityConfigCommandInput extends DeleteSecurityConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSecurityConfigCommand}.
13
17
  */
14
18
  export interface DeleteSecurityConfigCommandOutput extends DeleteSecurityConfigResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a security configuration for OpenSearch Serverless. For more information, see
18
23
  * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
19
24
  * authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -27,6 +32,8 @@ export interface DeleteSecurityConfigCommandOutput extends DeleteSecurityConfigR
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteSecurityConfigCommandInput - {@link DeleteSecurityConfigCommandInput}
36
+ * @returns {@link DeleteSecurityConfigCommandOutput}
30
37
  * @see {@link DeleteSecurityConfigCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteSecurityConfigCommandOutput} for command's `response` shape.
32
39
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteSecurityConfigCommandOutput extends DeleteSecurityConfigR
51
58
  export declare class DeleteSecurityConfigCommand extends $Command<DeleteSecurityConfigCommandInput, DeleteSecurityConfigCommandOutput, OpenSearchServerlessClientResolvedConfig> {
52
59
  readonly input: DeleteSecurityConfigCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteSecurityConfigCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSecurityConfigCommandInput, DeleteSecurityConfigCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSecurityPolicyRequest, DeleteSecurityPolicyResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSecurityPolicyCommand}.
8
10
  */
9
11
  export interface DeleteSecurityPolicyCommandInput extends DeleteSecurityPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSecurityPolicyCommand}.
13
17
  */
14
18
  export interface DeleteSecurityPolicyCommandOutput extends DeleteSecurityPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an OpenSearch Serverless security policy.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteSecurityPolicyCommandOutput extends DeleteSecurityPolicyR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteSecurityPolicyCommandInput - {@link DeleteSecurityPolicyCommandInput}
34
+ * @returns {@link DeleteSecurityPolicyCommandOutput}
28
35
  * @see {@link DeleteSecurityPolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteSecurityPolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteSecurityPolicyCommandOutput extends DeleteSecurityPolicyR
49
56
  export declare class DeleteSecurityPolicyCommand extends $Command<DeleteSecurityPolicyCommandInput, DeleteSecurityPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
50
57
  readonly input: DeleteSecurityPolicyCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteSecurityPolicyCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSecurityPolicyCommandInput, DeleteSecurityPolicyCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteVpcEndpointRequest, DeleteVpcEndpointResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteVpcEndpointCommand}.
8
10
  */
9
11
  export interface DeleteVpcEndpointCommandInput extends DeleteVpcEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteVpcEndpointCommand}.
13
17
  */
14
18
  export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see
18
23
  * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteVpcEndpointCommandInput - {@link DeleteVpcEndpointCommandInput}
35
+ * @returns {@link DeleteVpcEndpointCommandOutput}
29
36
  * @see {@link DeleteVpcEndpointCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteVpcEndpointCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointRespons
50
57
  export declare class DeleteVpcEndpointCommand extends $Command<DeleteVpcEndpointCommandInput, DeleteVpcEndpointCommandOutput, OpenSearchServerlessClientResolvedConfig> {
51
58
  readonly input: DeleteVpcEndpointCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteVpcEndpointCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteVpcEndpointCommandInput, DeleteVpcEndpointCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetAccessPolicyRequest, GetAccessPolicyResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAccessPolicyCommand}.
8
10
  */
9
11
  export interface GetAccessPolicyCommandInput extends GetAccessPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAccessPolicyCommand}.
13
17
  */
14
18
  export interface GetAccessPolicyCommandOutput extends GetAccessPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
18
23
  * access control for Amazon OpenSearch Serverless</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetAccessPolicyCommandOutput extends GetAccessPolicyResponse, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetAccessPolicyCommandInput - {@link GetAccessPolicyCommandInput}
35
+ * @returns {@link GetAccessPolicyCommandOutput}
29
36
  * @see {@link GetAccessPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link GetAccessPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetAccessPolicyCommandOutput extends GetAccessPolicyResponse, _
45
52
  export declare class GetAccessPolicyCommand extends $Command<GetAccessPolicyCommandInput, GetAccessPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
46
53
  readonly input: GetAccessPolicyCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetAccessPolicyCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccessPolicyCommandInput, GetAccessPolicyCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetAccountSettingsRequest, GetAccountSettingsResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAccountSettingsCommand}.
8
10
  */
9
11
  export interface GetAccountSettingsCommandInput extends GetAccountSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAccountSettingsCommand}.
13
17
  */
14
18
  export interface GetAccountSettingsCommandOutput extends GetAccountSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns account-level settings related to OpenSearch Serverless.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetAccountSettingsCommandInput - {@link GetAccountSettingsCommandInput}
34
+ * @returns {@link GetAccountSettingsCommandOutput}
28
35
  * @see {@link GetAccountSettingsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetAccountSettingsCommandOutput} for command's `response` shape.
30
37
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -41,11 +48,20 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsRespo
41
48
  export declare class GetAccountSettingsCommand extends $Command<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput, OpenSearchServerlessClientResolvedConfig> {
42
49
  readonly input: GetAccountSettingsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: GetAccountSettingsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetPoliciesStatsRequest, GetPoliciesStatsResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPoliciesStatsCommand}.
8
10
  */
9
11
  export interface GetPoliciesStatsCommandInput extends GetPoliciesStatsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPoliciesStatsCommand}.
13
17
  */
14
18
  export interface GetPoliciesStatsCommandOutput extends GetPoliciesStatsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns statistical information about your OpenSearch Serverless access policies, security
18
23
  * configurations, and security policies.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetPoliciesStatsCommandOutput extends GetPoliciesStatsResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetPoliciesStatsCommandInput - {@link GetPoliciesStatsCommandInput}
35
+ * @returns {@link GetPoliciesStatsCommandOutput}
29
36
  * @see {@link GetPoliciesStatsCommandInput} for command's `input` shape.
30
37
  * @see {@link GetPoliciesStatsCommandOutput} for command's `response` shape.
31
38
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -38,11 +45,20 @@ export interface GetPoliciesStatsCommandOutput extends GetPoliciesStatsResponse,
38
45
  export declare class GetPoliciesStatsCommand extends $Command<GetPoliciesStatsCommandInput, GetPoliciesStatsCommandOutput, OpenSearchServerlessClientResolvedConfig> {
39
46
  readonly input: GetPoliciesStatsCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: GetPoliciesStatsCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPoliciesStatsCommandInput, GetPoliciesStatsCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSecurityConfigRequest, GetSecurityConfigResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSecurityConfigCommand}.
8
10
  */
9
11
  export interface GetSecurityConfigCommandInput extends GetSecurityConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSecurityConfigCommand}.
13
17
  */
14
18
  export interface GetSecurityConfigCommandOutput extends GetSecurityConfigResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about an OpenSearch Serverless security configuration. For more information, see
18
23
  * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
19
24
  * authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -27,6 +32,8 @@ export interface GetSecurityConfigCommandOutput extends GetSecurityConfigRespons
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetSecurityConfigCommandInput - {@link GetSecurityConfigCommandInput}
36
+ * @returns {@link GetSecurityConfigCommandOutput}
30
37
  * @see {@link GetSecurityConfigCommandInput} for command's `input` shape.
31
38
  * @see {@link GetSecurityConfigCommandOutput} for command's `response` shape.
32
39
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetSecurityConfigCommandOutput extends GetSecurityConfigRespons
46
53
  export declare class GetSecurityConfigCommand extends $Command<GetSecurityConfigCommandInput, GetSecurityConfigCommandOutput, OpenSearchServerlessClientResolvedConfig> {
47
54
  readonly input: GetSecurityConfigCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetSecurityConfigCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSecurityConfigCommandInput, GetSecurityConfigCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSecurityPolicyRequest, GetSecurityPolicyResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSecurityPolicyCommand}.
8
10
  */
9
11
  export interface GetSecurityPolicyCommandInput extends GetSecurityPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSecurityPolicyCommand}.
13
17
  */
14
18
  export interface GetSecurityPolicyCommandOutput extends GetSecurityPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a configured OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access
18
23
  * for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at
19
24
  * rest for Amazon OpenSearch Serverless</a>.</p>
@@ -27,6 +32,8 @@ export interface GetSecurityPolicyCommandOutput extends GetSecurityPolicyRespons
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetSecurityPolicyCommandInput - {@link GetSecurityPolicyCommandInput}
36
+ * @returns {@link GetSecurityPolicyCommandOutput}
30
37
  * @see {@link GetSecurityPolicyCommandInput} for command's `input` shape.
31
38
  * @see {@link GetSecurityPolicyCommandOutput} for command's `response` shape.
32
39
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetSecurityPolicyCommandOutput extends GetSecurityPolicyRespons
46
53
  export declare class GetSecurityPolicyCommand extends $Command<GetSecurityPolicyCommandInput, GetSecurityPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
47
54
  readonly input: GetSecurityPolicyCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetSecurityPolicyCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSecurityPolicyCommandInput, GetSecurityPolicyCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAccessPoliciesRequest, ListAccessPoliciesResponse } from "../models/models_0";
5
5
  import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAccessPoliciesCommand}.
8
10
  */
9
11
  export interface ListAccessPoliciesCommandInput extends ListAccessPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAccessPoliciesCommand}.
13
17
  */
14
18
  export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a list of OpenSearch Serverless access policies.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListAccessPoliciesCommandInput - {@link ListAccessPoliciesCommandInput}
34
+ * @returns {@link ListAccessPoliciesCommandOutput}
28
35
  * @see {@link ListAccessPoliciesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListAccessPoliciesCommandOutput} for command's `response` shape.
30
37
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo
41
48
  export declare class ListAccessPoliciesCommand extends $Command<ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput, OpenSearchServerlessClientResolvedConfig> {
42
49
  readonly input: ListAccessPoliciesCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListAccessPoliciesCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }