@aws-sdk/client-dax 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 (26) hide show
  1. package/dist-types/DAX.d.ts +22 -0
  2. package/dist-types/DAXClient.d.ts +24 -4
  3. package/dist-types/commands/CreateClusterCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateParameterGroupCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateSubnetGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/DecreaseReplicationFactorCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteClusterCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteParameterGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteSubnetGroupCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeClustersCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeDefaultParametersCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeParameterGroupsCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeParametersCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeSubnetGroupsCommand.d.ts +16 -0
  16. package/dist-types/commands/IncreaseReplicationFactorCommand.d.ts +16 -0
  17. package/dist-types/commands/ListTagsCommand.d.ts +16 -0
  18. package/dist-types/commands/RebootNodeCommand.d.ts +16 -0
  19. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  20. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
  22. package/dist-types/commands/UpdateParameterGroupCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateSubnetGroupCommand.d.ts +16 -0
  24. package/dist-types/models/DAXServiceException.d.ts +2 -0
  25. package/dist-types/models/models_0.d.ts +187 -0
  26. package/package.json +29 -29
@@ -22,6 +22,7 @@ import { UpdateParameterGroupCommandInput, UpdateParameterGroupCommandOutput } f
22
22
  import { UpdateSubnetGroupCommandInput, UpdateSubnetGroupCommandOutput } from "./commands/UpdateSubnetGroupCommand";
23
23
  import { DAXClient } from "./DAXClient";
24
24
  /**
25
+ * @public
25
26
  * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX
26
27
  * dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so
27
28
  * applications can access that data with sub-millisecond latency. You can create a DAX
@@ -31,12 +32,14 @@ import { DAXClient } from "./DAXClient";
31
32
  */
32
33
  export declare class DAX extends DAXClient {
33
34
  /**
35
+ * @public
34
36
  * <p>Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.</p>
35
37
  */
36
38
  createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>;
37
39
  createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
38
40
  createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
39
41
  /**
42
+ * @public
40
43
  * <p>Creates a new parameter group. A parameter group is a collection of parameters that
41
44
  * you apply to all of the nodes in a DAX cluster.</p>
42
45
  */
@@ -44,12 +47,14 @@ export declare class DAX extends DAXClient {
44
47
  createParameterGroup(args: CreateParameterGroupCommandInput, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void): void;
45
48
  createParameterGroup(args: CreateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void): void;
46
49
  /**
50
+ * @public
47
51
  * <p>Creates a new subnet group.</p>
48
52
  */
49
53
  createSubnetGroup(args: CreateSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubnetGroupCommandOutput>;
50
54
  createSubnetGroup(args: CreateSubnetGroupCommandInput, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void): void;
51
55
  createSubnetGroup(args: CreateSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void): void;
52
56
  /**
57
+ * @public
53
58
  * <p>Removes one or more nodes from a DAX cluster.</p>
54
59
  * <note>
55
60
  * <p>You cannot use <code>DecreaseReplicationFactor</code> to remove the last node in a DAX cluster. If you need to do this, use <code>DeleteCluster</code> instead.</p>
@@ -59,6 +64,7 @@ export declare class DAX extends DAXClient {
59
64
  decreaseReplicationFactor(args: DecreaseReplicationFactorCommandInput, cb: (err: any, data?: DecreaseReplicationFactorCommandOutput) => void): void;
60
65
  decreaseReplicationFactor(args: DecreaseReplicationFactorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseReplicationFactorCommandOutput) => void): void;
61
66
  /**
67
+ * @public
62
68
  * <p>Deletes a previously provisioned DAX cluster.
63
69
  * <i>DeleteCluster</i> deletes all associated nodes, node endpoints
64
70
  * and the DAX cluster itself. When you receive a successful response from this action,
@@ -69,6 +75,7 @@ export declare class DAX extends DAXClient {
69
75
  deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
70
76
  deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
71
77
  /**
78
+ * @public
72
79
  * <p>Deletes the specified parameter group. You cannot delete a parameter group if it is
73
80
  * associated with any DAX clusters.</p>
74
81
  */
@@ -76,6 +83,7 @@ export declare class DAX extends DAXClient {
76
83
  deleteParameterGroup(args: DeleteParameterGroupCommandInput, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void): void;
77
84
  deleteParameterGroup(args: DeleteParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void): void;
78
85
  /**
86
+ * @public
79
87
  * <p>Deletes a subnet group.</p>
80
88
  * <note>
81
89
  * <p>You cannot delete a subnet group if it is associated with any DAX
@@ -86,6 +94,7 @@ export declare class DAX extends DAXClient {
86
94
  deleteSubnetGroup(args: DeleteSubnetGroupCommandInput, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void): void;
87
95
  deleteSubnetGroup(args: DeleteSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void): void;
88
96
  /**
97
+ * @public
89
98
  * <p>Returns information about all provisioned DAX clusters if no cluster identifier
90
99
  * is specified, or about a specific DAX cluster if a cluster identifier is
91
100
  * supplied.</p>
@@ -104,6 +113,7 @@ export declare class DAX extends DAXClient {
104
113
  describeClusters(args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
105
114
  describeClusters(args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
106
115
  /**
116
+ * @public
107
117
  * <p>Returns the default system parameter information for the DAX caching
108
118
  * software.</p>
109
119
  */
@@ -111,6 +121,7 @@ export declare class DAX extends DAXClient {
111
121
  describeDefaultParameters(args: DescribeDefaultParametersCommandInput, cb: (err: any, data?: DescribeDefaultParametersCommandOutput) => void): void;
112
122
  describeDefaultParameters(args: DescribeDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultParametersCommandOutput) => void): void;
113
123
  /**
124
+ * @public
114
125
  * <p>Returns events related to DAX clusters and parameter groups. You can obtain
115
126
  * events specific to a particular DAX cluster or parameter group by providing the name
116
127
  * as a parameter.</p>
@@ -121,6 +132,7 @@ export declare class DAX extends DAXClient {
121
132
  describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
122
133
  describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
123
134
  /**
135
+ * @public
124
136
  * <p>Returns a list of parameter group descriptions. If a parameter group name is
125
137
  * specified, the list will contain only the descriptions for that group.</p>
126
138
  */
@@ -128,12 +140,14 @@ export declare class DAX extends DAXClient {
128
140
  describeParameterGroups(args: DescribeParameterGroupsCommandInput, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void): void;
129
141
  describeParameterGroups(args: DescribeParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void): void;
130
142
  /**
143
+ * @public
131
144
  * <p>Returns the detailed parameter list for a particular parameter group.</p>
132
145
  */
133
146
  describeParameters(args: DescribeParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeParametersCommandOutput>;
134
147
  describeParameters(args: DescribeParametersCommandInput, cb: (err: any, data?: DescribeParametersCommandOutput) => void): void;
135
148
  describeParameters(args: DescribeParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParametersCommandOutput) => void): void;
136
149
  /**
150
+ * @public
137
151
  * <p>Returns a list of subnet group descriptions. If a subnet group name is specified,
138
152
  * the list will contain only the description of that group.</p>
139
153
  */
@@ -141,12 +155,14 @@ export declare class DAX extends DAXClient {
141
155
  describeSubnetGroups(args: DescribeSubnetGroupsCommandInput, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void): void;
142
156
  describeSubnetGroups(args: DescribeSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void): void;
143
157
  /**
158
+ * @public
144
159
  * <p>Adds one or more nodes to a DAX cluster.</p>
145
160
  */
146
161
  increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, options?: __HttpHandlerOptions): Promise<IncreaseReplicationFactorCommandOutput>;
147
162
  increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, cb: (err: any, data?: IncreaseReplicationFactorCommandOutput) => void): void;
148
163
  increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseReplicationFactorCommandOutput) => void): void;
149
164
  /**
165
+ * @public
150
166
  * <p>List all of the tags for a DAX cluster. You can call <code>ListTags</code> up to
151
167
  * 10 times per second, per account.</p>
152
168
  */
@@ -154,6 +170,7 @@ export declare class DAX extends DAXClient {
154
170
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
155
171
  listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
156
172
  /**
173
+ * @public
157
174
  * <p>Reboots a single node of a DAX cluster. The reboot action takes place
158
175
  * as soon as possible. During the
159
176
  * reboot, the node status is set to REBOOTING.</p>
@@ -166,6 +183,7 @@ export declare class DAX extends DAXClient {
166
183
  rebootNode(args: RebootNodeCommandInput, cb: (err: any, data?: RebootNodeCommandOutput) => void): void;
167
184
  rebootNode(args: RebootNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootNodeCommandOutput) => void): void;
168
185
  /**
186
+ * @public
169
187
  * <p>Associates a set of tags with a DAX resource. You can call <code>TagResource</code> up to 5 times per second, per
170
188
  * account. </p>
171
189
  */
@@ -173,6 +191,7 @@ export declare class DAX extends DAXClient {
173
191
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
174
192
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
175
193
  /**
194
+ * @public
176
195
  * <p>Removes the association of tags from a DAX resource. You can call
177
196
  * <code>UntagResource</code> up to 5 times per second, per account. </p>
178
197
  */
@@ -180,6 +199,7 @@ export declare class DAX extends DAXClient {
180
199
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
181
200
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
182
201
  /**
202
+ * @public
183
203
  * <p>Modifies the settings for a DAX cluster. You can use this action to change one or
184
204
  * more cluster configuration parameters by specifying the parameters and the new
185
205
  * values.</p>
@@ -188,6 +208,7 @@ export declare class DAX extends DAXClient {
188
208
  updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
189
209
  updateCluster(args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
190
210
  /**
211
+ * @public
191
212
  * <p>Modifies the parameters of a parameter group. You can modify up to 20
192
213
  * parameters in a single request by submitting a list parameter name and value
193
214
  * pairs.</p>
@@ -196,6 +217,7 @@ export declare class DAX extends DAXClient {
196
217
  updateParameterGroup(args: UpdateParameterGroupCommandInput, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void): void;
197
218
  updateParameterGroup(args: UpdateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void): void;
198
219
  /**
220
+ * @public
199
221
  * <p>Modifies an existing subnet group.</p>
200
222
  */
201
223
  updateSubnetGroup(args: UpdateSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubnetGroupCommandOutput>;
@@ -29,15 +29,24 @@ import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./command
29
29
  import { UpdateParameterGroupCommandInput, UpdateParameterGroupCommandOutput } from "./commands/UpdateParameterGroupCommand";
30
30
  import { UpdateSubnetGroupCommandInput, UpdateSubnetGroupCommandOutput } from "./commands/UpdateSubnetGroupCommand";
31
31
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
32
+ /**
33
+ * @public
34
+ */
32
35
  export type ServiceInputTypes = CreateClusterCommandInput | CreateParameterGroupCommandInput | CreateSubnetGroupCommandInput | DecreaseReplicationFactorCommandInput | DeleteClusterCommandInput | DeleteParameterGroupCommandInput | DeleteSubnetGroupCommandInput | DescribeClustersCommandInput | DescribeDefaultParametersCommandInput | DescribeEventsCommandInput | DescribeParameterGroupsCommandInput | DescribeParametersCommandInput | DescribeSubnetGroupsCommandInput | IncreaseReplicationFactorCommandInput | ListTagsCommandInput | RebootNodeCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateClusterCommandInput | UpdateParameterGroupCommandInput | UpdateSubnetGroupCommandInput;
36
+ /**
37
+ * @public
38
+ */
33
39
  export type ServiceOutputTypes = CreateClusterCommandOutput | CreateParameterGroupCommandOutput | CreateSubnetGroupCommandOutput | DecreaseReplicationFactorCommandOutput | DeleteClusterCommandOutput | DeleteParameterGroupCommandOutput | DeleteSubnetGroupCommandOutput | DescribeClustersCommandOutput | DescribeDefaultParametersCommandOutput | DescribeEventsCommandOutput | DescribeParameterGroupsCommandOutput | DescribeParametersCommandOutput | DescribeSubnetGroupsCommandOutput | IncreaseReplicationFactorCommandOutput | ListTagsCommandOutput | RebootNodeCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateClusterCommandOutput | UpdateParameterGroupCommandOutput | UpdateSubnetGroupCommandOutput;
40
+ /**
41
+ * @public
42
+ */
34
43
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
35
44
  /**
36
45
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
37
46
  */
38
47
  requestHandler?: __HttpHandler;
39
48
  /**
40
- * A constructor for a class implementing the {@link __Checksum} interface
49
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
41
50
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
42
51
  * @internal
43
52
  */
@@ -127,23 +136,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
127
136
  */
128
137
  logger?: __Logger;
129
138
  /**
130
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
139
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
140
  */
132
141
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
133
142
  }
143
+ /**
144
+ * @public
145
+ */
134
146
  type DAXClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
135
147
  /**
136
- * The configuration interface of DAXClient class constructor that set the region, credentials and other options.
148
+ * @public
149
+ *
150
+ * The configuration interface of DAXClient class constructor that set the region, credentials and other options.
137
151
  */
138
152
  export interface DAXClientConfig extends DAXClientConfigType {
139
153
  }
154
+ /**
155
+ * @public
156
+ */
140
157
  type DAXClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
141
158
  /**
142
- * The resolved configuration interface of DAXClient class. This is resolved and normalized from the {@link DAXClientConfig | constructor configuration interface}.
159
+ * @public
160
+ *
161
+ * The resolved configuration interface of DAXClient class. This is resolved and normalized from the {@link DAXClientConfig | constructor configuration interface}.
143
162
  */
144
163
  export interface DAXClientResolvedConfig extends DAXClientResolvedConfigType {
145
164
  }
146
165
  /**
166
+ * @public
147
167
  * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX
148
168
  * dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so
149
169
  * applications can access that data with sub-millisecond latency. You can create a DAX
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { CreateClusterRequest, CreateClusterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterCommand}.
8
10
  */
9
11
  export interface CreateClusterCommandInput extends CreateClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterCommand}.
13
17
  */
14
18
  export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.</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 CreateClusterCommandOutput extends CreateClusterResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
34
+ * @returns {@link CreateClusterCommandOutput}
28
35
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -87,11 +94,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
87
94
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, DAXClientResolvedConfig> {
88
95
  readonly input: CreateClusterCommandInput;
89
96
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
97
+ /**
98
+ * @public
99
+ */
90
100
  constructor(input: CreateClusterCommandInput);
91
101
  /**
92
102
  * @internal
93
103
  */
94
104
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
105
+ /**
106
+ * @internal
107
+ */
95
108
  private serialize;
109
+ /**
110
+ * @internal
111
+ */
96
112
  private deserialize;
97
113
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { CreateParameterGroupRequest, CreateParameterGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateParameterGroupCommand}.
8
10
  */
9
11
  export interface CreateParameterGroupCommandInput extends CreateParameterGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateParameterGroupCommand}.
13
17
  */
14
18
  export interface CreateParameterGroupCommandOutput extends CreateParameterGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new parameter group. A parameter group is a collection of parameters that
18
23
  * you apply to all of the nodes in a DAX cluster.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateParameterGroupCommandOutput extends CreateParameterGroupR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateParameterGroupCommandInput - {@link CreateParameterGroupCommandInput}
35
+ * @returns {@link CreateParameterGroupCommandOutput}
29
36
  * @see {@link CreateParameterGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateParameterGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateParameterGroupCommandOutput extends CreateParameterGroupR
53
60
  export declare class CreateParameterGroupCommand extends $Command<CreateParameterGroupCommandInput, CreateParameterGroupCommandOutput, DAXClientResolvedConfig> {
54
61
  readonly input: CreateParameterGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateParameterGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateParameterGroupCommandInput, CreateParameterGroupCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { CreateSubnetGroupRequest, CreateSubnetGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSubnetGroupCommand}.
8
10
  */
9
11
  export interface CreateSubnetGroupCommandInput extends CreateSubnetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSubnetGroupCommand}.
13
17
  */
14
18
  export interface CreateSubnetGroupCommandOutput extends CreateSubnetGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new 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 CreateSubnetGroupCommandOutput extends CreateSubnetGroupRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateSubnetGroupCommandInput - {@link CreateSubnetGroupCommandInput}
34
+ * @returns {@link CreateSubnetGroupCommandOutput}
28
35
  * @see {@link CreateSubnetGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateSubnetGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -51,11 +58,20 @@ export interface CreateSubnetGroupCommandOutput extends CreateSubnetGroupRespons
51
58
  export declare class CreateSubnetGroupCommand extends $Command<CreateSubnetGroupCommandInput, CreateSubnetGroupCommandOutput, DAXClientResolvedConfig> {
52
59
  readonly input: CreateSubnetGroupCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: CreateSubnetGroupCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSubnetGroupCommandInput, CreateSubnetGroupCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { DecreaseReplicationFactorRequest, DecreaseReplicationFactorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DecreaseReplicationFactorCommand}.
8
10
  */
9
11
  export interface DecreaseReplicationFactorCommandInput extends DecreaseReplicationFactorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DecreaseReplicationFactorCommand}.
13
17
  */
14
18
  export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicationFactorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more nodes from a DAX cluster.</p>
18
23
  * <note>
19
24
  * <p>You cannot use <code>DecreaseReplicationFactor</code> to remove the last node in a DAX cluster. If you need to do this, use <code>DeleteCluster</code> instead.</p>
@@ -28,6 +33,8 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DecreaseReplicationFactorCommandInput - {@link DecreaseReplicationFactorCommandInput}
37
+ * @returns {@link DecreaseReplicationFactorCommandOutput}
31
38
  * @see {@link DecreaseReplicationFactorCommandInput} for command's `input` shape.
32
39
  * @see {@link DecreaseReplicationFactorCommandOutput} for command's `response` shape.
33
40
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat
56
63
  export declare class DecreaseReplicationFactorCommand extends $Command<DecreaseReplicationFactorCommandInput, DecreaseReplicationFactorCommandOutput, DAXClientResolvedConfig> {
57
64
  readonly input: DecreaseReplicationFactorCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DecreaseReplicationFactorCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecreaseReplicationFactorCommandInput, DecreaseReplicationFactorCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { DeleteClusterRequest, DeleteClusterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteClusterCommand}.
8
10
  */
9
11
  export interface DeleteClusterCommandInput extends DeleteClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteClusterCommand}.
13
17
  */
14
18
  export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a previously provisioned DAX cluster.
18
23
  * <i>DeleteCluster</i> deletes all associated nodes, node endpoints
19
24
  * and the DAX cluster itself. When you receive a successful response from this action,
@@ -29,6 +34,8 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput}
38
+ * @returns {@link DeleteClusterCommandOutput}
32
39
  * @see {@link DeleteClusterCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
34
41
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
54
61
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, DAXClientResolvedConfig> {
55
62
  readonly input: DeleteClusterCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteClusterCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClusterCommandInput, DeleteClusterCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { DeleteParameterGroupRequest, DeleteParameterGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteParameterGroupCommand}.
8
10
  */
9
11
  export interface DeleteParameterGroupCommandInput extends DeleteParameterGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteParameterGroupCommand}.
13
17
  */
14
18
  export interface DeleteParameterGroupCommandOutput extends DeleteParameterGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified parameter group. You cannot delete a parameter group if it is
18
23
  * associated with any DAX clusters.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteParameterGroupCommandOutput extends DeleteParameterGroupR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteParameterGroupCommandInput - {@link DeleteParameterGroupCommandInput}
35
+ * @returns {@link DeleteParameterGroupCommandOutput}
29
36
  * @see {@link DeleteParameterGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteParameterGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteParameterGroupCommandOutput extends DeleteParameterGroupR
50
57
  export declare class DeleteParameterGroupCommand extends $Command<DeleteParameterGroupCommandInput, DeleteParameterGroupCommandOutput, DAXClientResolvedConfig> {
51
58
  readonly input: DeleteParameterGroupCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteParameterGroupCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteParameterGroupCommandInput, DeleteParameterGroupCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { DeleteSubnetGroupRequest, DeleteSubnetGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSubnetGroupCommand}.
8
10
  */
9
11
  export interface DeleteSubnetGroupCommandInput extends DeleteSubnetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSubnetGroupCommand}.
13
17
  */
14
18
  export interface DeleteSubnetGroupCommandOutput extends DeleteSubnetGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a subnet group.</p>
18
23
  * <note>
19
24
  * <p>You cannot delete a subnet group if it is associated with any DAX
@@ -29,6 +34,8 @@ export interface DeleteSubnetGroupCommandOutput extends DeleteSubnetGroupRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteSubnetGroupCommandInput - {@link DeleteSubnetGroupCommandInput}
38
+ * @returns {@link DeleteSubnetGroupCommandOutput}
32
39
  * @see {@link DeleteSubnetGroupCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteSubnetGroupCommandOutput} for command's `response` shape.
34
41
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteSubnetGroupCommandOutput extends DeleteSubnetGroupRespons
48
55
  export declare class DeleteSubnetGroupCommand extends $Command<DeleteSubnetGroupCommandInput, DeleteSubnetGroupCommandOutput, DAXClientResolvedConfig> {
49
56
  readonly input: DeleteSubnetGroupCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteSubnetGroupCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSubnetGroupCommandInput, DeleteSubnetGroupCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient";
5
5
  import { DescribeClustersRequest, DescribeClustersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeClustersCommand}.
8
10
  */
9
11
  export interface DescribeClustersCommandInput extends DescribeClustersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeClustersCommand}.
13
17
  */
14
18
  export interface DescribeClustersCommandOutput extends DescribeClustersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about all provisioned DAX clusters if no cluster identifier
18
23
  * is specified, or about a specific DAX cluster if a cluster identifier is
19
24
  * supplied.</p>
@@ -37,6 +42,8 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param DescribeClustersCommandInput - {@link DescribeClustersCommandInput}
46
+ * @returns {@link DescribeClustersCommandOutput}
40
47
  * @see {@link DescribeClustersCommandInput} for command's `input` shape.
41
48
  * @see {@link DescribeClustersCommandOutput} for command's `response` shape.
42
49
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
58
65
  export declare class DescribeClustersCommand extends $Command<DescribeClustersCommandInput, DescribeClustersCommandOutput, DAXClientResolvedConfig> {
59
66
  readonly input: DescribeClustersCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DescribeClustersCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DAXClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeClustersCommandInput, DescribeClustersCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }