@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 { CacheParameterGroupNameMessage, ResetCacheParameterGroupMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ResetCacheParameterGroupCommand}.
8
10
  */
9
11
  export interface ResetCacheParameterGroupCommandInput extends ResetCacheParameterGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ResetCacheParameterGroupCommand}.
13
17
  */
14
18
  export interface ResetCacheParameterGroupCommandOutput extends CacheParameterGroupNameMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies the parameters of a cache
18
23
  * parameter group to the engine or system default value. You can reset specific parameters
19
24
  * by submitting a list of parameter names. To reset the entire cache parameter group,
@@ -28,6 +33,8 @@ export interface ResetCacheParameterGroupCommandOutput extends CacheParameterGro
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ResetCacheParameterGroupCommandInput - {@link ResetCacheParameterGroupCommandInput}
37
+ * @returns {@link ResetCacheParameterGroupCommandOutput}
31
38
  * @see {@link ResetCacheParameterGroupCommandInput} for command's `input` shape.
32
39
  * @see {@link ResetCacheParameterGroupCommandOutput} for command's `response` shape.
33
40
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -69,11 +76,20 @@ export interface ResetCacheParameterGroupCommandOutput extends CacheParameterGro
69
76
  export declare class ResetCacheParameterGroupCommand extends $Command<ResetCacheParameterGroupCommandInput, ResetCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
70
77
  readonly input: ResetCacheParameterGroupCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: ResetCacheParameterGroupCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ResetCacheParameterGroupCommandInput, ResetCacheParameterGroupCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { RevokeCacheSecurityGroupIngressMessage, RevokeCacheSecurityGroupIngressResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RevokeCacheSecurityGroupIngressCommand}.
8
10
  */
9
11
  export interface RevokeCacheSecurityGroupIngressCommandInput extends RevokeCacheSecurityGroupIngressMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RevokeCacheSecurityGroupIngressCommand}.
13
17
  */
14
18
  export interface RevokeCacheSecurityGroupIngressCommandOutput extends RevokeCacheSecurityGroupIngressResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Revokes ingress from a cache security group.
18
23
  * Use this operation to disallow access from an Amazon EC2 security group
19
24
  * that had been previously authorized.</p>
@@ -27,6 +32,8 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput extends RevokeCach
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param RevokeCacheSecurityGroupIngressCommandInput - {@link RevokeCacheSecurityGroupIngressCommandInput}
36
+ * @returns {@link RevokeCacheSecurityGroupIngressCommandOutput}
30
37
  * @see {@link RevokeCacheSecurityGroupIngressCommandInput} for command's `input` shape.
31
38
  * @see {@link RevokeCacheSecurityGroupIngressCommandOutput} for command's `response` shape.
32
39
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -64,11 +71,20 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput extends RevokeCach
64
71
  export declare class RevokeCacheSecurityGroupIngressCommand extends $Command<RevokeCacheSecurityGroupIngressCommandInput, RevokeCacheSecurityGroupIngressCommandOutput, ElastiCacheClientResolvedConfig> {
65
72
  readonly input: RevokeCacheSecurityGroupIngressCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: RevokeCacheSecurityGroupIngressCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RevokeCacheSecurityGroupIngressCommandInput, RevokeCacheSecurityGroupIngressCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { StartMigrationMessage, StartMigrationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartMigrationCommand}.
8
10
  */
9
11
  export interface StartMigrationCommandInput extends StartMigrationMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartMigrationCommand}.
13
17
  */
14
18
  export interface StartMigrationCommandOutput extends StartMigrationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Start the migration of data.</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 StartMigrationCommandOutput extends StartMigrationResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartMigrationCommandInput - {@link StartMigrationCommandInput}
34
+ * @returns {@link StartMigrationCommandOutput}
28
35
  * @see {@link StartMigrationCommandInput} for command's `input` shape.
29
36
  * @see {@link StartMigrationCommandOutput} for command's `response` shape.
30
37
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -46,11 +53,20 @@ export interface StartMigrationCommandOutput extends StartMigrationResponse, __M
46
53
  export declare class StartMigrationCommand extends $Command<StartMigrationCommandInput, StartMigrationCommandOutput, ElastiCacheClientResolvedConfig> {
47
54
  readonly input: StartMigrationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: StartMigrationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMigrationCommandInput, StartMigrationCommandOutput>;
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 { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
5
5
  import { TestFailoverMessage, TestFailoverResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TestFailoverCommand}.
8
10
  */
9
11
  export interface TestFailoverCommandInput extends TestFailoverMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TestFailoverCommand}.
13
17
  */
14
18
  export interface TestFailoverCommandOutput extends TestFailoverResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on
18
23
  * a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>
19
24
  * <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool
@@ -86,6 +91,8 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
86
91
  * const response = await client.send(command);
87
92
  * ```
88
93
  *
94
+ * @param TestFailoverCommandInput - {@link TestFailoverCommandInput}
95
+ * @returns {@link TestFailoverCommandOutput}
89
96
  * @see {@link TestFailoverCommandInput} for command's `input` shape.
90
97
  * @see {@link TestFailoverCommandOutput} for command's `response` shape.
91
98
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
@@ -123,11 +130,20 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
123
130
  export declare class TestFailoverCommand extends $Command<TestFailoverCommandInput, TestFailoverCommandOutput, ElastiCacheClientResolvedConfig> {
124
131
  readonly input: TestFailoverCommandInput;
125
132
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
133
+ /**
134
+ * @public
135
+ */
126
136
  constructor(input: TestFailoverCommandInput);
127
137
  /**
128
138
  * @internal
129
139
  */
130
140
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestFailoverCommandInput, TestFailoverCommandOutput>;
141
+ /**
142
+ * @internal
143
+ */
131
144
  private serialize;
145
+ /**
146
+ * @internal
147
+ */
132
148
  private deserialize;
133
149
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ElastiCache service.
4
6
  */
5
7
  export declare class ElastiCacheServiceException extends __ServiceException {