@aws-sdk/client-elasticache 3.296.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 (90) hide show
  1. package/dist-cjs/protocols/Aws_query.js +174 -839
  2. package/dist-es/protocols/Aws_query.js +174 -839
  3. package/dist-types/ElastiCache.d.ts +66 -0
  4. package/dist-types/ElastiCacheClient.d.ts +24 -4
  5. package/dist-types/commands/AddTagsToResourceCommand.d.ts +16 -0
  6. package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +16 -0
  7. package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +16 -0
  8. package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +16 -0
  9. package/dist-types/commands/CompleteMigrationCommand.d.ts +16 -0
  10. package/dist-types/commands/CopySnapshotCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateCacheClusterCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateReplicationGroupCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateSnapshotCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  19. package/dist-types/commands/CreateUserGroupCommand.d.ts +16 -0
  20. package/dist-types/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +16 -0
  21. package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteCacheClusterCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteSnapshotCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteUserGroupCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeCacheClustersCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeCacheParametersCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeServiceUpdatesCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeUpdateActionsCommand.d.ts +16 -0
  46. package/dist-types/commands/DescribeUserGroupsCommand.d.ts +16 -0
  47. package/dist-types/commands/DescribeUsersCommand.d.ts +16 -0
  48. package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +16 -0
  49. package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +16 -0
  50. package/dist-types/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +16 -0
  51. package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +16 -0
  52. package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  54. package/dist-types/commands/ModifyCacheClusterCommand.d.ts +16 -0
  55. package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +16 -0
  56. package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +16 -0
  57. package/dist-types/commands/ModifyGlobalReplicationGroupCommand.d.ts +16 -0
  58. package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +16 -0
  59. package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +16 -0
  60. package/dist-types/commands/ModifyUserCommand.d.ts +16 -0
  61. package/dist-types/commands/ModifyUserGroupCommand.d.ts +16 -0
  62. package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +16 -0
  63. package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +16 -0
  64. package/dist-types/commands/RebootCacheClusterCommand.d.ts +16 -0
  65. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +16 -0
  67. package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +16 -0
  68. package/dist-types/commands/StartMigrationCommand.d.ts +16 -0
  69. package/dist-types/commands/TestFailoverCommand.d.ts +16 -0
  70. package/dist-types/models/ElastiCacheServiceException.d.ts +2 -0
  71. package/dist-types/models/models_0.d.ts +458 -0
  72. package/dist-types/pagination/DescribeCacheClustersPaginator.d.ts +3 -0
  73. package/dist-types/pagination/DescribeCacheEngineVersionsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/DescribeCacheParameterGroupsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/DescribeCacheParametersPaginator.d.ts +3 -0
  76. package/dist-types/pagination/DescribeCacheSecurityGroupsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/DescribeCacheSubnetGroupsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/DescribeEngineDefaultParametersPaginator.d.ts +3 -0
  79. package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/DescribeGlobalReplicationGroupsPaginator.d.ts +3 -0
  81. package/dist-types/pagination/DescribeReplicationGroupsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/DescribeReservedCacheNodesOfferingsPaginator.d.ts +3 -0
  83. package/dist-types/pagination/DescribeReservedCacheNodesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/DescribeServiceUpdatesPaginator.d.ts +3 -0
  85. package/dist-types/pagination/DescribeSnapshotsPaginator.d.ts +3 -0
  86. package/dist-types/pagination/DescribeUpdateActionsPaginator.d.ts +3 -0
  87. package/dist-types/pagination/DescribeUserGroupsPaginator.d.ts +3 -0
  88. package/dist-types/pagination/DescribeUsersPaginator.d.ts +3 -0
  89. package/dist-types/pagination/Interfaces.d.ts +3 -0
  90. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyCacheClusterMessage, ModifyCacheClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyCacheClusterCommand}.
8
10
  */
9
11
  export interface ModifyCacheClusterCommandInput extends ModifyCacheClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyCacheClusterCommand}.
13
17
  */
14
18
  export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the settings for a cluster. You
18
23
  * can use this operation to change one or more cluster configuration parameters by
19
24
  * specifying the parameters and the new values.</p>
@@ -27,6 +32,8 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ModifyCacheClusterCommandInput - {@link ModifyCacheClusterCommandInput}
36
+ * @returns {@link ModifyCacheClusterCommandOutput}
30
37
  * @see {@link ModifyCacheClusterCommandInput} for command's `input` shape.
31
38
  * @see {@link ModifyCacheClusterCommandOutput} for command's `response` shape.
32
39
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -110,11 +117,20 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul
110
117
  export declare class ModifyCacheClusterCommand extends $Command<ModifyCacheClusterCommandInput, ModifyCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
111
118
  readonly input: ModifyCacheClusterCommandInput;
112
119
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
120
+ /**
121
+ * @public
122
+ */
113
123
  constructor(input: ModifyCacheClusterCommandInput);
114
124
  /**
115
125
  * @internal
116
126
  */
117
127
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyCacheClusterCommandInput, ModifyCacheClusterCommandOutput>;
128
+ /**
129
+ * @internal
130
+ */
118
131
  private serialize;
132
+ /**
133
+ * @internal
134
+ */
119
135
  private deserialize;
120
136
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { CacheParameterGroupNameMessage, ModifyCacheParameterGroupMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyCacheParameterGroupCommand}.
8
10
  */
9
11
  export interface ModifyCacheParameterGroupCommandInput extends ModifyCacheParameterGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyCacheParameterGroupCommand}.
13
17
  */
14
18
  export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGroupNameMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the parameters of a cache
18
23
  * parameter group. You can modify up to 20 parameters in a single request by submitting a
19
24
  * list parameter name and value pairs.</p>
@@ -27,6 +32,8 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ModifyCacheParameterGroupCommandInput - {@link ModifyCacheParameterGroupCommandInput}
36
+ * @returns {@link ModifyCacheParameterGroupCommandOutput}
30
37
  * @see {@link ModifyCacheParameterGroupCommandInput} for command's `input` shape.
31
38
  * @see {@link ModifyCacheParameterGroupCommandOutput} for command's `response` shape.
32
39
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -77,11 +84,20 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr
77
84
  export declare class ModifyCacheParameterGroupCommand extends $Command<ModifyCacheParameterGroupCommandInput, ModifyCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
78
85
  readonly input: ModifyCacheParameterGroupCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: ModifyCacheParameterGroupCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyCacheParameterGroupCommandInput, ModifyCacheParameterGroupCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyCacheSubnetGroupMessage, ModifyCacheSubnetGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyCacheSubnetGroupCommand}.
8
10
  */
9
11
  export interface ModifyCacheSubnetGroupCommandInput extends ModifyCacheSubnetGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyCacheSubnetGroupCommand}.
13
17
  */
14
18
  export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies an existing cache subnet group.</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 ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ModifyCacheSubnetGroupCommandInput - {@link ModifyCacheSubnetGroupCommandInput}
34
+ * @returns {@link ModifyCacheSubnetGroupCommandOutput}
28
35
  * @see {@link ModifyCacheSubnetGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link ModifyCacheSubnetGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -105,11 +112,20 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr
105
112
  export declare class ModifyCacheSubnetGroupCommand extends $Command<ModifyCacheSubnetGroupCommandInput, ModifyCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
106
113
  readonly input: ModifyCacheSubnetGroupCommandInput;
107
114
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
115
+ /**
116
+ * @public
117
+ */
108
118
  constructor(input: ModifyCacheSubnetGroupCommandInput);
109
119
  /**
110
120
  * @internal
111
121
  */
112
122
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyCacheSubnetGroupCommandInput, ModifyCacheSubnetGroupCommandOutput>;
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 { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyGlobalReplicationGroupMessage, ModifyGlobalReplicationGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyGlobalReplicationGroupCommand}.
8
10
  */
9
11
  export interface ModifyGlobalReplicationGroupCommandInput extends ModifyGlobalReplicationGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyGlobalReplicationGroupCommand}.
13
17
  */
14
18
  export interface ModifyGlobalReplicationGroupCommandOutput extends ModifyGlobalReplicationGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the settings for a Global datastore.</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 ModifyGlobalReplicationGroupCommandOutput extends ModifyGlobalR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ModifyGlobalReplicationGroupCommandInput - {@link ModifyGlobalReplicationGroupCommandInput}
34
+ * @returns {@link ModifyGlobalReplicationGroupCommandOutput}
28
35
  * @see {@link ModifyGlobalReplicationGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link ModifyGlobalReplicationGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ModifyGlobalReplicationGroupCommandOutput extends ModifyGlobalR
43
50
  export declare class ModifyGlobalReplicationGroupCommand extends $Command<ModifyGlobalReplicationGroupCommandInput, ModifyGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
44
51
  readonly input: ModifyGlobalReplicationGroupCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ModifyGlobalReplicationGroupCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyGlobalReplicationGroupCommandInput, ModifyGlobalReplicationGroupCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyReplicationGroupMessage, ModifyReplicationGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyReplicationGroupCommand}.
8
10
  */
9
11
  export interface ModifyReplicationGroupCommandInput extends ModifyReplicationGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyReplicationGroupCommand}.
13
17
  */
14
18
  export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the settings for a replication group.</p>
18
23
  * <ul>
19
24
  * <li>
@@ -40,6 +45,8 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param ModifyReplicationGroupCommandInput - {@link ModifyReplicationGroupCommandInput}
49
+ * @returns {@link ModifyReplicationGroupCommandOutput}
43
50
  * @see {@link ModifyReplicationGroupCommandInput} for command's `input` shape.
44
51
  * @see {@link ModifyReplicationGroupCommandOutput} for command's `response` shape.
45
52
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -172,11 +179,20 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr
172
179
  export declare class ModifyReplicationGroupCommand extends $Command<ModifyReplicationGroupCommandInput, ModifyReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
173
180
  readonly input: ModifyReplicationGroupCommandInput;
174
181
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
182
+ /**
183
+ * @public
184
+ */
175
185
  constructor(input: ModifyReplicationGroupCommandInput);
176
186
  /**
177
187
  * @internal
178
188
  */
179
189
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyReplicationGroupCommandInput, ModifyReplicationGroupCommandOutput>;
190
+ /**
191
+ * @internal
192
+ */
180
193
  private serialize;
194
+ /**
195
+ * @internal
196
+ */
181
197
  private deserialize;
182
198
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyReplicationGroupShardConfigurationMessage, ModifyReplicationGroupShardConfigurationResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyReplicationGroupShardConfigurationCommand}.
8
10
  */
9
11
  export interface ModifyReplicationGroupShardConfigurationCommandInput extends ModifyReplicationGroupShardConfigurationMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyReplicationGroupShardConfigurationCommand}.
13
17
  */
14
18
  export interface ModifyReplicationGroupShardConfigurationCommandOutput extends ModifyReplicationGroupShardConfigurationResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies a replication group's shards (node groups) by allowing you to
18
23
  * add shards, remove shards, or rebalance the keyspaces among existing shards.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput extends M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ModifyReplicationGroupShardConfigurationCommandInput - {@link ModifyReplicationGroupShardConfigurationCommandInput}
35
+ * @returns {@link ModifyReplicationGroupShardConfigurationCommandOutput}
29
36
  * @see {@link ModifyReplicationGroupShardConfigurationCommandInput} for command's `input` shape.
30
37
  * @see {@link ModifyReplicationGroupShardConfigurationCommandOutput} for command's `response` shape.
31
38
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -67,11 +74,20 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput extends M
67
74
  export declare class ModifyReplicationGroupShardConfigurationCommand extends $Command<ModifyReplicationGroupShardConfigurationCommandInput, ModifyReplicationGroupShardConfigurationCommandOutput, ElastiCacheClientResolvedConfig> {
68
75
  readonly input: ModifyReplicationGroupShardConfigurationCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: ModifyReplicationGroupShardConfigurationCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyReplicationGroupShardConfigurationCommandInput, ModifyReplicationGroupShardConfigurationCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyUserMessage, User } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyUserCommand}.
8
10
  */
9
11
  export interface ModifyUserCommandInput extends ModifyUserMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyUserCommand}.
13
17
  */
14
18
  export interface ModifyUserCommandOutput extends User, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes user password(s) and/or access string.</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 ModifyUserCommandOutput extends User, __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ModifyUserCommandInput - {@link ModifyUserCommandInput}
34
+ * @returns {@link ModifyUserCommandOutput}
28
35
  * @see {@link ModifyUserCommandInput} for command's `input` shape.
29
36
  * @see {@link ModifyUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ModifyUserCommandOutput extends User, __MetadataBearer {
49
56
  export declare class ModifyUserCommand extends $Command<ModifyUserCommandInput, ModifyUserCommandOutput, ElastiCacheClientResolvedConfig> {
50
57
  readonly input: ModifyUserCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ModifyUserCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyUserCommandInput, ModifyUserCommandOutput>;
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 { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { ModifyUserGroupMessage, UserGroup } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ModifyUserGroupCommand}.
8
10
  */
9
11
  export interface ModifyUserGroupCommandInput extends ModifyUserGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ModifyUserGroupCommand}.
13
17
  */
14
18
  export interface ModifyUserGroupCommandOutput extends UserGroup, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the list of users that belong to the user group.</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 ModifyUserGroupCommandOutput extends UserGroup, __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ModifyUserGroupCommandInput - {@link ModifyUserGroupCommandInput}
34
+ * @returns {@link ModifyUserGroupCommandOutput}
28
35
  * @see {@link ModifyUserGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link ModifyUserGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -58,11 +65,20 @@ export interface ModifyUserGroupCommandOutput extends UserGroup, __MetadataBeare
58
65
  export declare class ModifyUserGroupCommand extends $Command<ModifyUserGroupCommandInput, ModifyUserGroupCommandOutput, ElastiCacheClientResolvedConfig> {
59
66
  readonly input: ModifyUserGroupCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: ModifyUserGroupCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyUserGroupCommandInput, ModifyUserGroupCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { PurchaseReservedCacheNodesOfferingMessage, PurchaseReservedCacheNodesOfferingResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PurchaseReservedCacheNodesOfferingCommand}.
8
10
  */
9
11
  export interface PurchaseReservedCacheNodesOfferingCommandInput extends PurchaseReservedCacheNodesOfferingMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PurchaseReservedCacheNodesOfferingCommand}.
13
17
  */
14
18
  export interface PurchaseReservedCacheNodesOfferingCommandOutput extends PurchaseReservedCacheNodesOfferingResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows you to purchase a reserved
18
23
  * cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information,
19
24
  * see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html">Managing Costs with Reserved Nodes</a> for Redis or
@@ -28,6 +33,8 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput extends Purchas
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param PurchaseReservedCacheNodesOfferingCommandInput - {@link PurchaseReservedCacheNodesOfferingCommandInput}
37
+ * @returns {@link PurchaseReservedCacheNodesOfferingCommandOutput}
31
38
  * @see {@link PurchaseReservedCacheNodesOfferingCommandInput} for command's `input` shape.
32
39
  * @see {@link PurchaseReservedCacheNodesOfferingCommandOutput} for command's `response` shape.
33
40
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -66,11 +73,20 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput extends Purchas
66
73
  export declare class PurchaseReservedCacheNodesOfferingCommand extends $Command<PurchaseReservedCacheNodesOfferingCommandInput, PurchaseReservedCacheNodesOfferingCommandOutput, ElastiCacheClientResolvedConfig> {
67
74
  readonly input: PurchaseReservedCacheNodesOfferingCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: PurchaseReservedCacheNodesOfferingCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PurchaseReservedCacheNodesOfferingCommandInput, PurchaseReservedCacheNodesOfferingCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { RebalanceSlotsInGlobalReplicationGroupMessage, RebalanceSlotsInGlobalReplicationGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RebalanceSlotsInGlobalReplicationGroupCommand}.
8
10
  */
9
11
  export interface RebalanceSlotsInGlobalReplicationGroupCommandInput extends RebalanceSlotsInGlobalReplicationGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RebalanceSlotsInGlobalReplicationGroupCommand}.
13
17
  */
14
18
  export interface RebalanceSlotsInGlobalReplicationGroupCommandOutput extends RebalanceSlotsInGlobalReplicationGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Redistribute slots to ensure uniform distribution across existing shards in the cluster.</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 RebalanceSlotsInGlobalReplicationGroupCommandOutput extends Reb
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RebalanceSlotsInGlobalReplicationGroupCommandInput - {@link RebalanceSlotsInGlobalReplicationGroupCommandInput}
34
+ * @returns {@link RebalanceSlotsInGlobalReplicationGroupCommandOutput}
28
35
  * @see {@link RebalanceSlotsInGlobalReplicationGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link RebalanceSlotsInGlobalReplicationGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -43,11 +50,20 @@ export interface RebalanceSlotsInGlobalReplicationGroupCommandOutput extends Reb
43
50
  export declare class RebalanceSlotsInGlobalReplicationGroupCommand extends $Command<RebalanceSlotsInGlobalReplicationGroupCommandInput, RebalanceSlotsInGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
44
51
  readonly input: RebalanceSlotsInGlobalReplicationGroupCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: RebalanceSlotsInGlobalReplicationGroupCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RebalanceSlotsInGlobalReplicationGroupCommandInput, RebalanceSlotsInGlobalReplicationGroupCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { RebootCacheClusterMessage, RebootCacheClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RebootCacheClusterCommand}.
8
10
  */
9
11
  export interface RebootCacheClusterCommandInput extends RebootCacheClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RebootCacheClusterCommand}.
13
17
  */
14
18
  export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Reboots some, or all, of the cache nodes
18
23
  * within a provisioned cluster. This operation applies any modified cache parameter
19
24
  * groups to the cluster. The reboot operation takes place as soon as possible, and
@@ -35,6 +40,8 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param RebootCacheClusterCommandInput - {@link RebootCacheClusterCommandInput}
44
+ * @returns {@link RebootCacheClusterCommandOutput}
38
45
  * @see {@link RebootCacheClusterCommandInput} for command's `input` shape.
39
46
  * @see {@link RebootCacheClusterCommandOutput} for command's `response` shape.
40
47
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -94,11 +101,20 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul
94
101
  export declare class RebootCacheClusterCommand extends $Command<RebootCacheClusterCommandInput, RebootCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
95
102
  readonly input: RebootCacheClusterCommandInput;
96
103
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
104
+ /**
105
+ * @public
106
+ */
97
107
  constructor(input: RebootCacheClusterCommandInput);
98
108
  /**
99
109
  * @internal
100
110
  */
101
111
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RebootCacheClusterCommandInput, RebootCacheClusterCommandOutput>;
112
+ /**
113
+ * @internal
114
+ */
102
115
  private serialize;
116
+ /**
117
+ * @internal
118
+ */
103
119
  private deserialize;
104
120
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { RemoveTagsFromResourceMessage, TagListMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveTagsFromResourceCommand}.
8
10
  */
9
11
  export interface RemoveTagsFromResourceCommandInput extends RemoveTagsFromResourceMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveTagsFromResourceCommand}.
13
17
  */
14
18
  export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the tags identified by the <code>TagKeys</code>
18
23
  * list from the named resource. A tag is a key-value pair where the key and value are case-sensitive.
19
24
  * You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group.
@@ -28,6 +33,8 @@ export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __M
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param RemoveTagsFromResourceCommandInput - {@link RemoveTagsFromResourceCommandInput}
37
+ * @returns {@link RemoveTagsFromResourceCommandOutput}
31
38
  * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -115,11 +122,20 @@ export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __M
115
122
  export declare class RemoveTagsFromResourceCommand extends $Command<RemoveTagsFromResourceCommandInput, RemoveTagsFromResourceCommandOutput, ElastiCacheClientResolvedConfig> {
116
123
  readonly input: RemoveTagsFromResourceCommandInput;
117
124
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
125
+ /**
126
+ * @public
127
+ */
118
128
  constructor(input: RemoveTagsFromResourceCommandInput);
119
129
  /**
120
130
  * @internal
121
131
  */
122
132
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveTagsFromResourceCommandInput, RemoveTagsFromResourceCommandOutput>;
133
+ /**
134
+ * @internal
135
+ */
123
136
  private serialize;
137
+ /**
138
+ * @internal
139
+ */
124
140
  private deserialize;
125
141
  }