@aws-sdk/client-kms 3.295.0 → 3.297.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 (63) hide show
  1. package/dist-types/KMS.d.ts +51 -0
  2. package/dist-types/KMSClient.d.ts +24 -4
  3. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +16 -0
  4. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAliasCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateGrantCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
  9. package/dist-types/commands/DecryptCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteAliasCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
  15. package/dist-types/commands/DisableKeyCommand.d.ts +16 -0
  16. package/dist-types/commands/DisableKeyRotationCommand.d.ts +16 -0
  17. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -0
  18. package/dist-types/commands/EnableKeyCommand.d.ts +16 -0
  19. package/dist-types/commands/EnableKeyRotationCommand.d.ts +16 -0
  20. package/dist-types/commands/EncryptCommand.d.ts +16 -0
  21. package/dist-types/commands/GenerateDataKeyCommand.d.ts +16 -0
  22. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +16 -0
  23. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -0
  24. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -0
  25. package/dist-types/commands/GenerateMacCommand.d.ts +16 -0
  26. package/dist-types/commands/GenerateRandomCommand.d.ts +16 -0
  27. package/dist-types/commands/GetKeyPolicyCommand.d.ts +16 -0
  28. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +16 -0
  29. package/dist-types/commands/GetParametersForImportCommand.d.ts +16 -0
  30. package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
  31. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +16 -0
  32. package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
  33. package/dist-types/commands/ListGrantsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListKeysCommand.d.ts +16 -0
  36. package/dist-types/commands/ListResourceTagsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +16 -0
  38. package/dist-types/commands/PutKeyPolicyCommand.d.ts +16 -0
  39. package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
  40. package/dist-types/commands/ReplicateKeyCommand.d.ts +16 -0
  41. package/dist-types/commands/RetireGrantCommand.d.ts +16 -0
  42. package/dist-types/commands/RevokeGrantCommand.d.ts +16 -0
  43. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +16 -0
  44. package/dist-types/commands/SignCommand.d.ts +16 -0
  45. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  47. package/dist-types/commands/UpdateAliasCommand.d.ts +16 -0
  48. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +16 -0
  49. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +16 -0
  50. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +16 -0
  51. package/dist-types/commands/VerifyCommand.d.ts +16 -0
  52. package/dist-types/commands/VerifyMacCommand.d.ts +16 -0
  53. package/dist-types/models/KMSServiceException.d.ts +2 -0
  54. package/dist-types/models/models_0.d.ts +373 -0
  55. package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +3 -0
  56. package/dist-types/pagination/Interfaces.d.ts +3 -0
  57. package/dist-types/pagination/ListAliasesPaginator.d.ts +3 -0
  58. package/dist-types/pagination/ListGrantsPaginator.d.ts +3 -0
  59. package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +3 -0
  60. package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
  61. package/dist-types/pagination/ListResourceTagsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +3 -0
  63. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { GetPublicKeyRequest, GetPublicKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPublicKeyCommand}.
8
10
  */
9
11
  export interface GetPublicKeyCommandInput extends GetPublicKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPublicKeyCommand}.
13
17
  */
14
18
  export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
18
23
  * KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
19
24
  * permission can download the public key of an asymmetric KMS key. You can share the public key
@@ -73,6 +78,8 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
73
78
  * const response = await client.send(command);
74
79
  * ```
75
80
  *
81
+ * @param GetPublicKeyCommandInput - {@link GetPublicKeyCommandInput}
82
+ * @returns {@link GetPublicKeyCommandOutput}
76
83
  * @see {@link GetPublicKeyCommandInput} for command's `input` shape.
77
84
  * @see {@link GetPublicKeyCommandOutput} for command's `response` shape.
78
85
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -174,11 +181,20 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
174
181
  export declare class GetPublicKeyCommand extends $Command<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, KMSClientResolvedConfig> {
175
182
  readonly input: GetPublicKeyCommandInput;
176
183
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
184
+ /**
185
+ * @public
186
+ */
177
187
  constructor(input: GetPublicKeyCommandInput);
178
188
  /**
179
189
  * @internal
180
190
  */
181
191
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPublicKeyCommandInput, GetPublicKeyCommandOutput>;
192
+ /**
193
+ * @internal
194
+ */
182
195
  private serialize;
196
+ /**
197
+ * @internal
198
+ */
183
199
  private deserialize;
184
200
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ImportKeyMaterialRequest, ImportKeyMaterialResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ImportKeyMaterialCommand}.
8
10
  */
9
11
  export interface ImportKeyMaterialCommandInput extends ImportKeyMaterialRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ImportKeyMaterialCommand}.
13
17
  */
14
18
  export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Imports key material into an existing symmetric encryption KMS key that was created
18
23
  * without key material. After you successfully import key material into a KMS key, you can
19
24
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that KMS key, but you cannot import different
@@ -88,6 +93,8 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
88
93
  * const response = await client.send(command);
89
94
  * ```
90
95
  *
96
+ * @param ImportKeyMaterialCommandInput - {@link ImportKeyMaterialCommandInput}
97
+ * @returns {@link ImportKeyMaterialCommandOutput}
91
98
  * @see {@link ImportKeyMaterialCommandInput} for command's `input` shape.
92
99
  * @see {@link ImportKeyMaterialCommandOutput} for command's `response` shape.
93
100
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -169,11 +176,20 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
169
176
  export declare class ImportKeyMaterialCommand extends $Command<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput, KMSClientResolvedConfig> {
170
177
  readonly input: ImportKeyMaterialCommandInput;
171
178
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
179
+ /**
180
+ * @public
181
+ */
172
182
  constructor(input: ImportKeyMaterialCommandInput);
173
183
  /**
174
184
  * @internal
175
185
  */
176
186
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput>;
187
+ /**
188
+ * @internal
189
+ */
177
190
  private serialize;
191
+ /**
192
+ * @internal
193
+ */
178
194
  private deserialize;
179
195
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListAliasesRequest, ListAliasesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAliasesCommand}.
8
10
  */
9
11
  export interface ListAliasesCommandInput extends ListAliasesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAliasesCommand}.
13
17
  */
14
18
  export interface ListAliasesCommandOutput extends ListAliasesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
18
23
  * about aliases, see <a>CreateAlias</a>.</p>
19
24
  * <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
@@ -65,6 +70,8 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
65
70
  * const response = await client.send(command);
66
71
  * ```
67
72
  *
73
+ * @param ListAliasesCommandInput - {@link ListAliasesCommandInput}
74
+ * @returns {@link ListAliasesCommandOutput}
68
75
  * @see {@link ListAliasesCommandInput} for command's `input` shape.
69
76
  * @see {@link ListAliasesCommandOutput} for command's `response` shape.
70
77
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -150,11 +157,20 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
150
157
  export declare class ListAliasesCommand extends $Command<ListAliasesCommandInput, ListAliasesCommandOutput, KMSClientResolvedConfig> {
151
158
  readonly input: ListAliasesCommandInput;
152
159
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
160
+ /**
161
+ * @public
162
+ */
153
163
  constructor(input: ListAliasesCommandInput);
154
164
  /**
155
165
  * @internal
156
166
  */
157
167
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAliasesCommandInput, ListAliasesCommandOutput>;
168
+ /**
169
+ * @internal
170
+ */
158
171
  private serialize;
172
+ /**
173
+ * @internal
174
+ */
159
175
  private deserialize;
160
176
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListGrantsRequest, ListGrantsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGrantsCommand}.
8
10
  */
9
11
  export interface ListGrantsCommandInput extends ListGrantsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGrantsCommand}.
13
17
  */
14
18
  export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of all grants for the specified KMS key. </p>
18
23
  * <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
19
24
  * grantee principal.</p>
@@ -69,6 +74,8 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
69
74
  * const response = await client.send(command);
70
75
  * ```
71
76
  *
77
+ * @param ListGrantsCommandInput - {@link ListGrantsCommandInput}
78
+ * @returns {@link ListGrantsCommandOutput}
72
79
  * @see {@link ListGrantsCommandInput} for command's `input` shape.
73
80
  * @see {@link ListGrantsCommandOutput} for command's `response` shape.
74
81
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -188,11 +195,20 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
188
195
  export declare class ListGrantsCommand extends $Command<ListGrantsCommandInput, ListGrantsCommandOutput, KMSClientResolvedConfig> {
189
196
  readonly input: ListGrantsCommandInput;
190
197
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
198
+ /**
199
+ * @public
200
+ */
191
201
  constructor(input: ListGrantsCommandInput);
192
202
  /**
193
203
  * @internal
194
204
  */
195
205
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGrantsCommandInput, ListGrantsCommandOutput>;
206
+ /**
207
+ * @internal
208
+ */
196
209
  private serialize;
210
+ /**
211
+ * @internal
212
+ */
197
213
  private deserialize;
198
214
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListKeyPoliciesRequest, ListKeyPoliciesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListKeyPoliciesCommand}.
8
10
  */
9
11
  export interface ListKeyPoliciesCommandInput extends ListKeyPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListKeyPoliciesCommand}.
13
17
  */
14
18
  export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the names of the key policies that are attached to a KMS key. This operation is
18
23
  * designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation.
19
24
  * However, the only valid policy name is <code>default</code>. </p>
@@ -46,6 +51,8 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param ListKeyPoliciesCommandInput - {@link ListKeyPoliciesCommandInput}
55
+ * @returns {@link ListKeyPoliciesCommandOutput}
49
56
  * @see {@link ListKeyPoliciesCommandInput} for command's `input` shape.
50
57
  * @see {@link ListKeyPoliciesCommandOutput} for command's `response` shape.
51
58
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -108,11 +115,20 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
108
115
  export declare class ListKeyPoliciesCommand extends $Command<ListKeyPoliciesCommandInput, ListKeyPoliciesCommandOutput, KMSClientResolvedConfig> {
109
116
  readonly input: ListKeyPoliciesCommandInput;
110
117
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
118
+ /**
119
+ * @public
120
+ */
111
121
  constructor(input: ListKeyPoliciesCommandInput);
112
122
  /**
113
123
  * @internal
114
124
  */
115
125
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKeyPoliciesCommandInput, ListKeyPoliciesCommandOutput>;
126
+ /**
127
+ * @internal
128
+ */
116
129
  private serialize;
130
+ /**
131
+ * @internal
132
+ */
117
133
  private deserialize;
118
134
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListKeysRequest, ListKeysResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListKeysCommand}.
8
10
  */
9
11
  export interface ListKeysCommandInput extends ListKeysRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListKeysCommand}.
13
17
  */
14
18
  export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
18
23
  * <p>
19
24
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
@@ -54,6 +59,8 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
54
59
  * const response = await client.send(command);
55
60
  * ```
56
61
  *
62
+ * @param ListKeysCommandInput - {@link ListKeysCommandInput}
63
+ * @returns {@link ListKeysCommandOutput}
57
64
  * @see {@link ListKeysCommandInput} for command's `input` shape.
58
65
  * @see {@link ListKeysCommandOutput} for command's `response` shape.
59
66
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -119,11 +126,20 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
119
126
  export declare class ListKeysCommand extends $Command<ListKeysCommandInput, ListKeysCommandOutput, KMSClientResolvedConfig> {
120
127
  readonly input: ListKeysCommandInput;
121
128
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
122
132
  constructor(input: ListKeysCommandInput);
123
133
  /**
124
134
  * @internal
125
135
  */
126
136
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKeysCommandInput, ListKeysCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
127
140
  private serialize;
141
+ /**
142
+ * @internal
143
+ */
128
144
  private deserialize;
129
145
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListResourceTagsRequest, ListResourceTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListResourceTagsCommand}.
8
10
  */
9
11
  export interface ListResourceTagsCommandInput extends ListResourceTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListResourceTagsCommand}.
13
17
  */
14
18
  export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns all tags on the specified KMS key.</p>
18
23
  * <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
19
24
  * the <i>Amazon Web Services General Reference</i>. For information about using
@@ -58,6 +63,8 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
58
63
  * const response = await client.send(command);
59
64
  * ```
60
65
  *
66
+ * @param ListResourceTagsCommandInput - {@link ListResourceTagsCommandInput}
67
+ * @returns {@link ListResourceTagsCommandOutput}
61
68
  * @see {@link ListResourceTagsCommandInput} for command's `input` shape.
62
69
  * @see {@link ListResourceTagsCommandOutput} for command's `response` shape.
63
70
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -113,11 +120,20 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
113
120
  export declare class ListResourceTagsCommand extends $Command<ListResourceTagsCommandInput, ListResourceTagsCommandOutput, KMSClientResolvedConfig> {
114
121
  readonly input: ListResourceTagsCommandInput;
115
122
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
123
+ /**
124
+ * @public
125
+ */
116
126
  constructor(input: ListResourceTagsCommandInput);
117
127
  /**
118
128
  * @internal
119
129
  */
120
130
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListResourceTagsCommandInput, ListResourceTagsCommandOutput>;
131
+ /**
132
+ * @internal
133
+ */
121
134
  private serialize;
135
+ /**
136
+ * @internal
137
+ */
122
138
  private deserialize;
123
139
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListGrantsResponse, ListRetirableGrantsRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListRetirableGrantsCommand}.
8
10
  */
9
11
  export interface ListRetirableGrantsCommandInput extends ListRetirableGrantsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListRetirableGrantsCommand}.
13
17
  */
14
18
  export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about all grants in the Amazon Web Services account and Region that have the
18
23
  * specified retiring principal. </p>
19
24
  * <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
@@ -67,6 +72,8 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
67
72
  * const response = await client.send(command);
68
73
  * ```
69
74
  *
75
+ * @param ListRetirableGrantsCommandInput - {@link ListRetirableGrantsCommandInput}
76
+ * @returns {@link ListRetirableGrantsCommandOutput}
70
77
  * @see {@link ListRetirableGrantsCommandInput} for command's `input` shape.
71
78
  * @see {@link ListRetirableGrantsCommandOutput} for command's `response` shape.
72
79
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -126,11 +133,20 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
126
133
  export declare class ListRetirableGrantsCommand extends $Command<ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput, KMSClientResolvedConfig> {
127
134
  readonly input: ListRetirableGrantsCommandInput;
128
135
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
136
+ /**
137
+ * @public
138
+ */
129
139
  constructor(input: ListRetirableGrantsCommandInput);
130
140
  /**
131
141
  * @internal
132
142
  */
133
143
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput>;
144
+ /**
145
+ * @internal
146
+ */
134
147
  private serialize;
148
+ /**
149
+ * @internal
150
+ */
135
151
  private deserialize;
136
152
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { PutKeyPolicyRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutKeyPolicyCommand}.
8
10
  */
9
11
  export interface PutKeyPolicyCommandInput extends PutKeyPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutKeyPolicyCommand}.
13
17
  */
14
18
  export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Attaches a key policy to the specified KMS key. </p>
18
23
  * <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>Key Management Service Developer Guide</i>.
19
24
  * For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
@@ -37,6 +42,8 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param PutKeyPolicyCommandInput - {@link PutKeyPolicyCommandInput}
46
+ * @returns {@link PutKeyPolicyCommandOutput}
40
47
  * @see {@link PutKeyPolicyCommandInput} for command's `input` shape.
41
48
  * @see {@link PutKeyPolicyCommandOutput} for command's `response` shape.
42
49
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -105,11 +112,20 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
105
112
  export declare class PutKeyPolicyCommand extends $Command<PutKeyPolicyCommandInput, PutKeyPolicyCommandOutput, KMSClientResolvedConfig> {
106
113
  readonly input: PutKeyPolicyCommandInput;
107
114
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
115
+ /**
116
+ * @public
117
+ */
108
118
  constructor(input: PutKeyPolicyCommandInput);
109
119
  /**
110
120
  * @internal
111
121
  */
112
122
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutKeyPolicyCommandInput, PutKeyPolicyCommandOutput>;
123
+ /**
124
+ * @internal
125
+ */
113
126
  private serialize;
127
+ /**
128
+ * @internal
129
+ */
114
130
  private deserialize;
115
131
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ReEncryptRequest, ReEncryptResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ReEncryptCommand}.
8
10
  */
9
11
  export interface ReEncryptCommandInput extends ReEncryptRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ReEncryptCommand}.
13
17
  */
14
18
  export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
18
23
  * operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually
19
24
  * rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
@@ -119,6 +124,8 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
119
124
  * const response = await client.send(command);
120
125
  * ```
121
126
  *
127
+ * @param ReEncryptCommandInput - {@link ReEncryptCommandInput}
128
+ * @returns {@link ReEncryptCommandOutput}
122
129
  * @see {@link ReEncryptCommandInput} for command's `input` shape.
123
130
  * @see {@link ReEncryptCommandOutput} for command's `response` shape.
124
131
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -222,11 +229,20 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
222
229
  export declare class ReEncryptCommand extends $Command<ReEncryptCommandInput, ReEncryptCommandOutput, KMSClientResolvedConfig> {
223
230
  readonly input: ReEncryptCommandInput;
224
231
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
232
+ /**
233
+ * @public
234
+ */
225
235
  constructor(input: ReEncryptCommandInput);
226
236
  /**
227
237
  * @internal
228
238
  */
229
239
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReEncryptCommandInput, ReEncryptCommandOutput>;
240
+ /**
241
+ * @internal
242
+ */
230
243
  private serialize;
244
+ /**
245
+ * @internal
246
+ */
231
247
  private deserialize;
232
248
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ReplicateKeyRequest, ReplicateKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ReplicateKeyCommand}.
8
10
  */
9
11
  export interface ReplicateKeyCommandInput extends ReplicateKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ReplicateKeyCommand}.
13
17
  */
14
18
  export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Replicates a multi-Region key into the specified Region. This operation creates a
18
23
  * multi-Region replica key based on a multi-Region primary key in a different Region of the same
19
24
  * Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
@@ -107,6 +112,8 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
107
112
  * const response = await client.send(command);
108
113
  * ```
109
114
  *
115
+ * @param ReplicateKeyCommandInput - {@link ReplicateKeyCommandInput}
116
+ * @returns {@link ReplicateKeyCommandOutput}
110
117
  * @see {@link ReplicateKeyCommandInput} for command's `input` shape.
111
118
  * @see {@link ReplicateKeyCommandOutput} for command's `response` shape.
112
119
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -216,11 +223,20 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
216
223
  export declare class ReplicateKeyCommand extends $Command<ReplicateKeyCommandInput, ReplicateKeyCommandOutput, KMSClientResolvedConfig> {
217
224
  readonly input: ReplicateKeyCommandInput;
218
225
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
226
+ /**
227
+ * @public
228
+ */
219
229
  constructor(input: ReplicateKeyCommandInput);
220
230
  /**
221
231
  * @internal
222
232
  */
223
233
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReplicateKeyCommandInput, ReplicateKeyCommandOutput>;
234
+ /**
235
+ * @internal
236
+ */
224
237
  private serialize;
238
+ /**
239
+ * @internal
240
+ */
225
241
  private deserialize;
226
242
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { RetireGrantRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RetireGrantCommand}.
8
10
  */
9
11
  export interface RetireGrantCommandInput extends RetireGrantRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RetireGrantCommand}.
13
17
  */
14
18
  export interface RetireGrantCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
18
23
  * identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
19
24
  * key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
@@ -70,6 +75,8 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
70
75
  * const response = await client.send(command);
71
76
  * ```
72
77
  *
78
+ * @param RetireGrantCommandInput - {@link RetireGrantCommandInput}
79
+ * @returns {@link RetireGrantCommandOutput}
73
80
  * @see {@link RetireGrantCommandInput} for command's `input` shape.
74
81
  * @see {@link RetireGrantCommandOutput} for command's `response` shape.
75
82
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -131,11 +138,20 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
131
138
  export declare class RetireGrantCommand extends $Command<RetireGrantCommandInput, RetireGrantCommandOutput, KMSClientResolvedConfig> {
132
139
  readonly input: RetireGrantCommandInput;
133
140
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
141
+ /**
142
+ * @public
143
+ */
134
144
  constructor(input: RetireGrantCommandInput);
135
145
  /**
136
146
  * @internal
137
147
  */
138
148
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RetireGrantCommandInput, RetireGrantCommandOutput>;
149
+ /**
150
+ * @internal
151
+ */
139
152
  private serialize;
153
+ /**
154
+ * @internal
155
+ */
140
156
  private deserialize;
141
157
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { RevokeGrantRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RevokeGrantCommand}.
8
10
  */
9
11
  export interface RevokeGrantCommandInput extends RevokeGrantRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RevokeGrantCommand}.
13
17
  */
14
18
  export interface RevokeGrantCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
18
23
  * grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
19
24
  * the <i>
@@ -68,6 +73,8 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
68
73
  * const response = await client.send(command);
69
74
  * ```
70
75
  *
76
+ * @param RevokeGrantCommandInput - {@link RevokeGrantCommandInput}
77
+ * @returns {@link RevokeGrantCommandOutput}
71
78
  * @see {@link RevokeGrantCommandInput} for command's `input` shape.
72
79
  * @see {@link RevokeGrantCommandOutput} for command's `response` shape.
73
80
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -126,11 +133,20 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
126
133
  export declare class RevokeGrantCommand extends $Command<RevokeGrantCommandInput, RevokeGrantCommandOutput, KMSClientResolvedConfig> {
127
134
  readonly input: RevokeGrantCommandInput;
128
135
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
136
+ /**
137
+ * @public
138
+ */
129
139
  constructor(input: RevokeGrantCommandInput);
130
140
  /**
131
141
  * @internal
132
142
  */
133
143
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RevokeGrantCommandInput, RevokeGrantCommandOutput>;
144
+ /**
145
+ * @internal
146
+ */
134
147
  private serialize;
148
+ /**
149
+ * @internal
150
+ */
135
151
  private deserialize;
136
152
  }