@aws-sdk/client-elasticache 3.325.0 → 3.326.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 (66) hide show
  1. package/dist-types/commands/AddTagsToResourceCommand.d.ts +11 -0
  2. package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +18 -0
  3. package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +22 -0
  4. package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +22 -0
  5. package/dist-types/commands/CompleteMigrationCommand.d.ts +123 -0
  6. package/dist-types/commands/CopySnapshotCommand.d.ts +57 -0
  7. package/dist-types/commands/CreateCacheClusterCommand.d.ts +117 -0
  8. package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +12 -0
  9. package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +18 -0
  10. package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +28 -0
  11. package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +33 -0
  12. package/dist-types/commands/CreateReplicationGroupCommand.d.ts +123 -0
  13. package/dist-types/commands/CreateSnapshotCommand.d.ts +57 -0
  14. package/dist-types/commands/CreateUserCommand.d.ts +19 -0
  15. package/dist-types/commands/CreateUserGroupCommand.d.ts +24 -0
  16. package/dist-types/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +33 -0
  17. package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +123 -0
  18. package/dist-types/commands/DeleteCacheClusterCommand.d.ts +117 -0
  19. package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +33 -0
  23. package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +123 -0
  24. package/dist-types/commands/DeleteSnapshotCommand.d.ts +57 -0
  25. package/dist-types/commands/DeleteUserCommand.d.ts +19 -0
  26. package/dist-types/commands/DeleteUserGroupCommand.d.ts +24 -0
  27. package/dist-types/commands/DescribeCacheClustersCommand.d.ts +120 -0
  28. package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +15 -0
  29. package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +15 -0
  30. package/dist-types/commands/DescribeCacheParametersCommand.d.ts +37 -0
  31. package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +21 -0
  32. package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +31 -0
  33. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +40 -0
  34. package/dist-types/commands/DescribeEventsCommand.d.ts +14 -0
  35. package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +36 -0
  36. package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +126 -0
  37. package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +28 -0
  38. package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +23 -0
  39. package/dist-types/commands/DescribeServiceUpdatesCommand.d.ts +22 -0
  40. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +60 -0
  41. package/dist-types/commands/DescribeUpdateActionsCommand.d.ts +55 -0
  42. package/dist-types/commands/DescribeUserGroupsCommand.d.ts +29 -0
  43. package/dist-types/commands/DescribeUsersCommand.d.ts +24 -0
  44. package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +33 -0
  45. package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +33 -0
  46. package/dist-types/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +33 -0
  47. package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +123 -0
  48. package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +11 -0
  49. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  50. package/dist-types/commands/ModifyCacheClusterCommand.d.ts +117 -0
  51. package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +6 -0
  52. package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +28 -0
  53. package/dist-types/commands/ModifyGlobalReplicationGroupCommand.d.ts +33 -0
  54. package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +123 -0
  55. package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +123 -0
  56. package/dist-types/commands/ModifyUserCommand.d.ts +19 -0
  57. package/dist-types/commands/ModifyUserGroupCommand.d.ts +24 -0
  58. package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +25 -0
  59. package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +33 -0
  60. package/dist-types/commands/RebootCacheClusterCommand.d.ts +117 -0
  61. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +11 -0
  62. package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +6 -0
  63. package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +18 -0
  64. package/dist-types/commands/StartMigrationCommand.d.ts +123 -0
  65. package/dist-types/commands/TestFailoverCommand.d.ts +123 -0
  66. package/package.json +3 -3
@@ -34,6 +34,44 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
34
34
  * };
35
35
  * const command = new DescribeEngineDefaultParametersCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeEngineDefaultParametersResult
38
+ * // EngineDefaults: { // EngineDefaults
39
+ * // CacheParameterGroupFamily: "STRING_VALUE",
40
+ * // Marker: "STRING_VALUE",
41
+ * // Parameters: [ // ParametersList
42
+ * // { // Parameter
43
+ * // ParameterName: "STRING_VALUE",
44
+ * // ParameterValue: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // Source: "STRING_VALUE",
47
+ * // DataType: "STRING_VALUE",
48
+ * // AllowedValues: "STRING_VALUE",
49
+ * // IsModifiable: true || false,
50
+ * // MinimumEngineVersion: "STRING_VALUE",
51
+ * // ChangeType: "immediate" || "requires-reboot",
52
+ * // },
53
+ * // ],
54
+ * // CacheNodeTypeSpecificParameters: [ // CacheNodeTypeSpecificParametersList
55
+ * // { // CacheNodeTypeSpecificParameter
56
+ * // ParameterName: "STRING_VALUE",
57
+ * // Description: "STRING_VALUE",
58
+ * // Source: "STRING_VALUE",
59
+ * // DataType: "STRING_VALUE",
60
+ * // AllowedValues: "STRING_VALUE",
61
+ * // IsModifiable: true || false,
62
+ * // MinimumEngineVersion: "STRING_VALUE",
63
+ * // CacheNodeTypeSpecificValues: [ // CacheNodeTypeSpecificValueList
64
+ * // { // CacheNodeTypeSpecificValue
65
+ * // CacheNodeType: "STRING_VALUE",
66
+ * // Value: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // ChangeType: "immediate" || "requires-reboot",
70
+ * // },
71
+ * // ],
72
+ * // },
73
+ * // };
74
+ *
37
75
  * ```
38
76
  *
39
77
  * @param DescribeEngineDefaultParametersCommandInput - {@link DescribeEngineDefaultParametersCommandInput}
@@ -48,6 +86,8 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
48
86
  * @throws {@link InvalidParameterValueException} (client fault)
49
87
  * <p>The value for a parameter is invalid.</p>
50
88
  *
89
+ * @throws {@link ElastiCacheServiceException}
90
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
51
91
  *
52
92
  * @example DescribeEngineDefaultParameters
53
93
  * ```javascript
@@ -42,6 +42,18 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
42
42
  * };
43
43
  * const command = new DescribeEventsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // EventsMessage
46
+ * // Marker: "STRING_VALUE",
47
+ * // Events: [ // EventList
48
+ * // { // Event
49
+ * // SourceIdentifier: "STRING_VALUE",
50
+ * // SourceType: "cache-cluster" || "cache-parameter-group" || "cache-security-group" || "cache-subnet-group" || "replication-group" || "user" || "user-group",
51
+ * // Message: "STRING_VALUE",
52
+ * // Date: new Date("TIMESTAMP"),
53
+ * // },
54
+ * // ],
55
+ * // };
56
+ *
45
57
  * ```
46
58
  *
47
59
  * @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput}
@@ -56,6 +68,8 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
56
68
  * @throws {@link InvalidParameterValueException} (client fault)
57
69
  * <p>The value for a parameter is invalid.</p>
58
70
  *
71
+ * @throws {@link ElastiCacheServiceException}
72
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
59
73
  *
60
74
  * @example DescribeEvents
61
75
  * ```javascript
@@ -34,6 +34,40 @@ export interface DescribeGlobalReplicationGroupsCommandOutput extends DescribeGl
34
34
  * };
35
35
  * const command = new DescribeGlobalReplicationGroupsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeGlobalReplicationGroupsResult
38
+ * // Marker: "STRING_VALUE",
39
+ * // GlobalReplicationGroups: [ // GlobalReplicationGroupList
40
+ * // { // GlobalReplicationGroup
41
+ * // GlobalReplicationGroupId: "STRING_VALUE",
42
+ * // GlobalReplicationGroupDescription: "STRING_VALUE",
43
+ * // Status: "STRING_VALUE",
44
+ * // CacheNodeType: "STRING_VALUE",
45
+ * // Engine: "STRING_VALUE",
46
+ * // EngineVersion: "STRING_VALUE",
47
+ * // Members: [ // GlobalReplicationGroupMemberList
48
+ * // { // GlobalReplicationGroupMember
49
+ * // ReplicationGroupId: "STRING_VALUE",
50
+ * // ReplicationGroupRegion: "STRING_VALUE",
51
+ * // Role: "STRING_VALUE",
52
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
53
+ * // Status: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // ClusterEnabled: true || false,
57
+ * // GlobalNodeGroups: [ // GlobalNodeGroupList
58
+ * // { // GlobalNodeGroup
59
+ * // GlobalNodeGroupId: "STRING_VALUE",
60
+ * // Slots: "STRING_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // AuthTokenEnabled: true || false,
64
+ * // TransitEncryptionEnabled: true || false,
65
+ * // AtRestEncryptionEnabled: true || false,
66
+ * // ARN: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // };
70
+ *
37
71
  * ```
38
72
  *
39
73
  * @param DescribeGlobalReplicationGroupsCommandInput - {@link DescribeGlobalReplicationGroupsCommandInput}
@@ -51,6 +85,8 @@ export interface DescribeGlobalReplicationGroupsCommandOutput extends DescribeGl
51
85
  * @throws {@link InvalidParameterValueException} (client fault)
52
86
  * <p>The value for a parameter is invalid.</p>
53
87
  *
88
+ * @throws {@link ElastiCacheServiceException}
89
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
54
90
  *
55
91
  */
56
92
  export declare class DescribeGlobalReplicationGroupsCommand extends $Command<DescribeGlobalReplicationGroupsCommandInput, DescribeGlobalReplicationGroupsCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -38,6 +38,130 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup
38
38
  * };
39
39
  * const command = new DescribeReplicationGroupsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ReplicationGroupMessage
42
+ * // Marker: "STRING_VALUE",
43
+ * // ReplicationGroups: [ // ReplicationGroupList
44
+ * // { // ReplicationGroup
45
+ * // ReplicationGroupId: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // GlobalReplicationGroupInfo: { // GlobalReplicationGroupInfo
48
+ * // GlobalReplicationGroupId: "STRING_VALUE",
49
+ * // GlobalReplicationGroupMemberRole: "STRING_VALUE",
50
+ * // },
51
+ * // Status: "STRING_VALUE",
52
+ * // PendingModifiedValues: { // ReplicationGroupPendingModifiedValues
53
+ * // PrimaryClusterId: "STRING_VALUE",
54
+ * // AutomaticFailoverStatus: "enabled" || "disabled",
55
+ * // Resharding: { // ReshardingStatus
56
+ * // SlotMigration: { // SlotMigration
57
+ * // ProgressPercentage: Number("double"),
58
+ * // },
59
+ * // },
60
+ * // AuthTokenStatus: "SETTING" || "ROTATING",
61
+ * // UserGroups: { // UserGroupsUpdateStatus
62
+ * // UserGroupIdsToAdd: [ // UserGroupIdList
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // UserGroupIdsToRemove: [
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // },
69
+ * // LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList
70
+ * // { // PendingLogDeliveryConfiguration
71
+ * // LogType: "slow-log" || "engine-log",
72
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
73
+ * // DestinationDetails: { // DestinationDetails
74
+ * // CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails
75
+ * // LogGroup: "STRING_VALUE",
76
+ * // },
77
+ * // KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails
78
+ * // DeliveryStream: "STRING_VALUE",
79
+ * // },
80
+ * // },
81
+ * // LogFormat: "text" || "json",
82
+ * // },
83
+ * // ],
84
+ * // TransitEncryptionEnabled: true || false,
85
+ * // TransitEncryptionMode: "preferred" || "required",
86
+ * // },
87
+ * // MemberClusters: [ // ClusterIdList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // NodeGroups: [ // NodeGroupList
91
+ * // { // NodeGroup
92
+ * // NodeGroupId: "STRING_VALUE",
93
+ * // Status: "STRING_VALUE",
94
+ * // PrimaryEndpoint: { // Endpoint
95
+ * // Address: "STRING_VALUE",
96
+ * // Port: Number("int"),
97
+ * // },
98
+ * // ReaderEndpoint: {
99
+ * // Address: "STRING_VALUE",
100
+ * // Port: Number("int"),
101
+ * // },
102
+ * // Slots: "STRING_VALUE",
103
+ * // NodeGroupMembers: [ // NodeGroupMemberList
104
+ * // { // NodeGroupMember
105
+ * // CacheClusterId: "STRING_VALUE",
106
+ * // CacheNodeId: "STRING_VALUE",
107
+ * // ReadEndpoint: {
108
+ * // Address: "STRING_VALUE",
109
+ * // Port: Number("int"),
110
+ * // },
111
+ * // PreferredAvailabilityZone: "STRING_VALUE",
112
+ * // PreferredOutpostArn: "STRING_VALUE",
113
+ * // CurrentRole: "STRING_VALUE",
114
+ * // },
115
+ * // ],
116
+ * // },
117
+ * // ],
118
+ * // SnapshottingClusterId: "STRING_VALUE",
119
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
120
+ * // MultiAZ: "enabled" || "disabled",
121
+ * // ConfigurationEndpoint: "<Endpoint>",
122
+ * // SnapshotRetentionLimit: Number("int"),
123
+ * // SnapshotWindow: "STRING_VALUE",
124
+ * // ClusterEnabled: true || false,
125
+ * // CacheNodeType: "STRING_VALUE",
126
+ * // AuthTokenEnabled: true || false,
127
+ * // AuthTokenLastModifiedDate: new Date("TIMESTAMP"),
128
+ * // TransitEncryptionEnabled: true || false,
129
+ * // AtRestEncryptionEnabled: true || false,
130
+ * // MemberClustersOutpostArns: [ // ReplicationGroupOutpostArnList
131
+ * // "STRING_VALUE",
132
+ * // ],
133
+ * // KmsKeyId: "STRING_VALUE",
134
+ * // ARN: "STRING_VALUE",
135
+ * // UserGroupIds: [
136
+ * // "STRING_VALUE",
137
+ * // ],
138
+ * // LogDeliveryConfigurations: [ // LogDeliveryConfigurationList
139
+ * // { // LogDeliveryConfiguration
140
+ * // LogType: "slow-log" || "engine-log",
141
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
142
+ * // DestinationDetails: {
143
+ * // CloudWatchLogsDetails: {
144
+ * // LogGroup: "STRING_VALUE",
145
+ * // },
146
+ * // KinesisFirehoseDetails: {
147
+ * // DeliveryStream: "STRING_VALUE",
148
+ * // },
149
+ * // },
150
+ * // LogFormat: "text" || "json",
151
+ * // Status: "active" || "enabling" || "modifying" || "disabling" || "error",
152
+ * // Message: "STRING_VALUE",
153
+ * // },
154
+ * // ],
155
+ * // ReplicationGroupCreateTime: new Date("TIMESTAMP"),
156
+ * // DataTiering: "enabled" || "disabled",
157
+ * // AutoMinorVersionUpgrade: true || false,
158
+ * // NetworkType: "ipv4" || "ipv6" || "dual_stack",
159
+ * // IpDiscovery: "ipv4" || "ipv6",
160
+ * // TransitEncryptionMode: "preferred" || "required",
161
+ * // },
162
+ * // ],
163
+ * // };
164
+ *
41
165
  * ```
42
166
  *
43
167
  * @param DescribeReplicationGroupsCommandInput - {@link DescribeReplicationGroupsCommandInput}
@@ -55,6 +179,8 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup
55
179
  * @throws {@link ReplicationGroupNotFoundFault} (client fault)
56
180
  * <p>The specified replication group does not exist.</p>
57
181
  *
182
+ * @throws {@link ElastiCacheServiceException}
183
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
58
184
  *
59
185
  * @example DescribeReplicationGroups
60
186
  * ```javascript
@@ -39,6 +39,32 @@ export interface DescribeReservedCacheNodesCommandOutput extends ReservedCacheNo
39
39
  * };
40
40
  * const command = new DescribeReservedCacheNodesCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ReservedCacheNodeMessage
43
+ * // Marker: "STRING_VALUE",
44
+ * // ReservedCacheNodes: [ // ReservedCacheNodeList
45
+ * // { // ReservedCacheNode
46
+ * // ReservedCacheNodeId: "STRING_VALUE",
47
+ * // ReservedCacheNodesOfferingId: "STRING_VALUE",
48
+ * // CacheNodeType: "STRING_VALUE",
49
+ * // StartTime: new Date("TIMESTAMP"),
50
+ * // Duration: Number("int"),
51
+ * // FixedPrice: Number("double"),
52
+ * // UsagePrice: Number("double"),
53
+ * // CacheNodeCount: Number("int"),
54
+ * // ProductDescription: "STRING_VALUE",
55
+ * // OfferingType: "STRING_VALUE",
56
+ * // State: "STRING_VALUE",
57
+ * // RecurringCharges: [ // RecurringChargeList
58
+ * // { // RecurringCharge
59
+ * // RecurringChargeAmount: Number("double"),
60
+ * // RecurringChargeFrequency: "STRING_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // ReservationARN: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // };
67
+ *
42
68
  * ```
43
69
  *
44
70
  * @param DescribeReservedCacheNodesCommandInput - {@link DescribeReservedCacheNodesCommandInput}
@@ -56,6 +82,8 @@ export interface DescribeReservedCacheNodesCommandOutput extends ReservedCacheNo
56
82
  * @throws {@link ReservedCacheNodeNotFoundFault} (client fault)
57
83
  * <p>The requested reserved cache node was not found.</p>
58
84
  *
85
+ * @throws {@link ElastiCacheServiceException}
86
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
59
87
  *
60
88
  * @example DescribeReservedCacheNodes
61
89
  * ```javascript
@@ -38,6 +38,27 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput extends Reserv
38
38
  * };
39
39
  * const command = new DescribeReservedCacheNodesOfferingsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ReservedCacheNodesOfferingMessage
42
+ * // Marker: "STRING_VALUE",
43
+ * // ReservedCacheNodesOfferings: [ // ReservedCacheNodesOfferingList
44
+ * // { // ReservedCacheNodesOffering
45
+ * // ReservedCacheNodesOfferingId: "STRING_VALUE",
46
+ * // CacheNodeType: "STRING_VALUE",
47
+ * // Duration: Number("int"),
48
+ * // FixedPrice: Number("double"),
49
+ * // UsagePrice: Number("double"),
50
+ * // ProductDescription: "STRING_VALUE",
51
+ * // OfferingType: "STRING_VALUE",
52
+ * // RecurringCharges: [ // RecurringChargeList
53
+ * // { // RecurringCharge
54
+ * // RecurringChargeAmount: Number("double"),
55
+ * // RecurringChargeFrequency: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
41
62
  * ```
42
63
  *
43
64
  * @param DescribeReservedCacheNodesOfferingsCommandInput - {@link DescribeReservedCacheNodesOfferingsCommandInput}
@@ -55,6 +76,8 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput extends Reserv
55
76
  * @throws {@link ReservedCacheNodesOfferingNotFoundFault} (client fault)
56
77
  * <p>The requested cache node offering does not exist.</p>
57
78
  *
79
+ * @throws {@link ElastiCacheServiceException}
80
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
58
81
  *
59
82
  * @example DescribeReseredCacheNodeOfferings
60
83
  * ```javascript
@@ -36,6 +36,26 @@ export interface DescribeServiceUpdatesCommandOutput extends ServiceUpdatesMessa
36
36
  * };
37
37
  * const command = new DescribeServiceUpdatesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ServiceUpdatesMessage
40
+ * // Marker: "STRING_VALUE",
41
+ * // ServiceUpdates: [ // ServiceUpdateList
42
+ * // { // ServiceUpdate
43
+ * // ServiceUpdateName: "STRING_VALUE",
44
+ * // ServiceUpdateReleaseDate: new Date("TIMESTAMP"),
45
+ * // ServiceUpdateEndDate: new Date("TIMESTAMP"),
46
+ * // ServiceUpdateSeverity: "critical" || "important" || "medium" || "low",
47
+ * // ServiceUpdateRecommendedApplyByDate: new Date("TIMESTAMP"),
48
+ * // ServiceUpdateStatus: "available" || "cancelled" || "expired",
49
+ * // ServiceUpdateDescription: "STRING_VALUE",
50
+ * // ServiceUpdateType: "security-update",
51
+ * // Engine: "STRING_VALUE",
52
+ * // EngineVersion: "STRING_VALUE",
53
+ * // AutoUpdateAfterRecommendedApplyByDate: true || false,
54
+ * // EstimatedUpdateTime: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // };
58
+ *
39
59
  * ```
40
60
  *
41
61
  * @param DescribeServiceUpdatesCommandInput - {@link DescribeServiceUpdatesCommandInput}
@@ -53,6 +73,8 @@ export interface DescribeServiceUpdatesCommandOutput extends ServiceUpdatesMessa
53
73
  * @throws {@link ServiceUpdateNotFoundFault} (client fault)
54
74
  * <p>The service update doesn't exist</p>
55
75
  *
76
+ * @throws {@link ElastiCacheServiceException}
77
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
56
78
  *
57
79
  */
58
80
  export declare class DescribeServiceUpdatesCommand extends $Command<DescribeServiceUpdatesCommandInput, DescribeServiceUpdatesCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -43,6 +43,64 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes
43
43
  * };
44
44
  * const command = new DescribeSnapshotsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DescribeSnapshotsListMessage
47
+ * // Marker: "STRING_VALUE",
48
+ * // Snapshots: [ // SnapshotList
49
+ * // { // Snapshot
50
+ * // SnapshotName: "STRING_VALUE",
51
+ * // ReplicationGroupId: "STRING_VALUE",
52
+ * // ReplicationGroupDescription: "STRING_VALUE",
53
+ * // CacheClusterId: "STRING_VALUE",
54
+ * // SnapshotStatus: "STRING_VALUE",
55
+ * // SnapshotSource: "STRING_VALUE",
56
+ * // CacheNodeType: "STRING_VALUE",
57
+ * // Engine: "STRING_VALUE",
58
+ * // EngineVersion: "STRING_VALUE",
59
+ * // NumCacheNodes: Number("int"),
60
+ * // PreferredAvailabilityZone: "STRING_VALUE",
61
+ * // PreferredOutpostArn: "STRING_VALUE",
62
+ * // CacheClusterCreateTime: new Date("TIMESTAMP"),
63
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
64
+ * // TopicArn: "STRING_VALUE",
65
+ * // Port: Number("int"),
66
+ * // CacheParameterGroupName: "STRING_VALUE",
67
+ * // CacheSubnetGroupName: "STRING_VALUE",
68
+ * // VpcId: "STRING_VALUE",
69
+ * // AutoMinorVersionUpgrade: true || false,
70
+ * // SnapshotRetentionLimit: Number("int"),
71
+ * // SnapshotWindow: "STRING_VALUE",
72
+ * // NumNodeGroups: Number("int"),
73
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
74
+ * // NodeSnapshots: [ // NodeSnapshotList
75
+ * // { // NodeSnapshot
76
+ * // CacheClusterId: "STRING_VALUE",
77
+ * // NodeGroupId: "STRING_VALUE",
78
+ * // CacheNodeId: "STRING_VALUE",
79
+ * // NodeGroupConfiguration: { // NodeGroupConfiguration
80
+ * // NodeGroupId: "STRING_VALUE",
81
+ * // Slots: "STRING_VALUE",
82
+ * // ReplicaCount: Number("int"),
83
+ * // PrimaryAvailabilityZone: "STRING_VALUE",
84
+ * // ReplicaAvailabilityZones: [ // AvailabilityZonesList
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // PrimaryOutpostArn: "STRING_VALUE",
88
+ * // ReplicaOutpostArns: [ // OutpostArnsList
89
+ * // "STRING_VALUE",
90
+ * // ],
91
+ * // },
92
+ * // CacheSize: "STRING_VALUE",
93
+ * // CacheNodeCreateTime: new Date("TIMESTAMP"),
94
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
95
+ * // },
96
+ * // ],
97
+ * // KmsKeyId: "STRING_VALUE",
98
+ * // ARN: "STRING_VALUE",
99
+ * // DataTiering: "enabled" || "disabled",
100
+ * // },
101
+ * // ],
102
+ * // };
103
+ *
46
104
  * ```
47
105
  *
48
106
  * @param DescribeSnapshotsCommandInput - {@link DescribeSnapshotsCommandInput}
@@ -63,6 +121,8 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes
63
121
  * @throws {@link SnapshotNotFoundFault} (client fault)
64
122
  * <p>The requested snapshot name does not refer to an existing snapshot.</p>
65
123
  *
124
+ * @throws {@link ElastiCacheServiceException}
125
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
66
126
  *
67
127
  * @example DescribeSnapshots
68
128
  * ```javascript
@@ -51,6 +51,59 @@ export interface DescribeUpdateActionsCommandOutput extends UpdateActionsMessage
51
51
  * };
52
52
  * const command = new DescribeUpdateActionsCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // UpdateActionsMessage
55
+ * // Marker: "STRING_VALUE",
56
+ * // UpdateActions: [ // UpdateActionList
57
+ * // { // UpdateAction
58
+ * // ReplicationGroupId: "STRING_VALUE",
59
+ * // CacheClusterId: "STRING_VALUE",
60
+ * // ServiceUpdateName: "STRING_VALUE",
61
+ * // ServiceUpdateReleaseDate: new Date("TIMESTAMP"),
62
+ * // ServiceUpdateSeverity: "critical" || "important" || "medium" || "low",
63
+ * // ServiceUpdateStatus: "available" || "cancelled" || "expired",
64
+ * // ServiceUpdateRecommendedApplyByDate: new Date("TIMESTAMP"),
65
+ * // ServiceUpdateType: "security-update",
66
+ * // UpdateActionAvailableDate: new Date("TIMESTAMP"),
67
+ * // UpdateActionStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete" || "scheduling" || "scheduled" || "not-applicable",
68
+ * // NodesUpdated: "STRING_VALUE",
69
+ * // UpdateActionStatusModifiedDate: new Date("TIMESTAMP"),
70
+ * // SlaMet: "yes" || "no" || "n/a",
71
+ * // NodeGroupUpdateStatus: [ // NodeGroupUpdateStatusList
72
+ * // { // NodeGroupUpdateStatus
73
+ * // NodeGroupId: "STRING_VALUE",
74
+ * // NodeGroupMemberUpdateStatus: [ // NodeGroupMemberUpdateStatusList
75
+ * // { // NodeGroupMemberUpdateStatus
76
+ * // CacheClusterId: "STRING_VALUE",
77
+ * // CacheNodeId: "STRING_VALUE",
78
+ * // NodeUpdateStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete",
79
+ * // NodeDeletionDate: new Date("TIMESTAMP"),
80
+ * // NodeUpdateStartDate: new Date("TIMESTAMP"),
81
+ * // NodeUpdateEndDate: new Date("TIMESTAMP"),
82
+ * // NodeUpdateInitiatedBy: "system" || "customer",
83
+ * // NodeUpdateInitiatedDate: new Date("TIMESTAMP"),
84
+ * // NodeUpdateStatusModifiedDate: new Date("TIMESTAMP"),
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // CacheNodeUpdateStatus: [ // CacheNodeUpdateStatusList
90
+ * // { // CacheNodeUpdateStatus
91
+ * // CacheNodeId: "STRING_VALUE",
92
+ * // NodeUpdateStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete",
93
+ * // NodeDeletionDate: new Date("TIMESTAMP"),
94
+ * // NodeUpdateStartDate: new Date("TIMESTAMP"),
95
+ * // NodeUpdateEndDate: new Date("TIMESTAMP"),
96
+ * // NodeUpdateInitiatedBy: "system" || "customer",
97
+ * // NodeUpdateInitiatedDate: new Date("TIMESTAMP"),
98
+ * // NodeUpdateStatusModifiedDate: new Date("TIMESTAMP"),
99
+ * // },
100
+ * // ],
101
+ * // EstimatedUpdateTime: "STRING_VALUE",
102
+ * // Engine: "STRING_VALUE",
103
+ * // },
104
+ * // ],
105
+ * // };
106
+ *
54
107
  * ```
55
108
  *
56
109
  * @param DescribeUpdateActionsCommandInput - {@link DescribeUpdateActionsCommandInput}
@@ -65,6 +118,8 @@ export interface DescribeUpdateActionsCommandOutput extends UpdateActionsMessage
65
118
  * @throws {@link InvalidParameterValueException} (client fault)
66
119
  * <p>The value for a parameter is invalid.</p>
67
120
  *
121
+ * @throws {@link ElastiCacheServiceException}
122
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
68
123
  *
69
124
  */
70
125
  export declare class DescribeUpdateActionsCommand extends $Command<DescribeUpdateActionsCommandInput, DescribeUpdateActionsCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -33,6 +33,33 @@ export interface DescribeUserGroupsCommandOutput extends DescribeUserGroupsResul
33
33
  * };
34
34
  * const command = new DescribeUserGroupsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeUserGroupsResult
37
+ * // UserGroups: [ // UserGroupList
38
+ * // { // UserGroup
39
+ * // UserGroupId: "STRING_VALUE",
40
+ * // Status: "STRING_VALUE",
41
+ * // Engine: "STRING_VALUE",
42
+ * // UserIds: [ // UserIdList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // MinimumEngineVersion: "STRING_VALUE",
46
+ * // PendingChanges: { // UserGroupPendingChanges
47
+ * // UserIdsToRemove: [
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // UserIdsToAdd: [
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // },
54
+ * // ReplicationGroups: [ // UGReplicationGroupIdList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // ARN: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // Marker: "STRING_VALUE",
61
+ * // };
62
+ *
36
63
  * ```
37
64
  *
38
65
  * @param DescribeUserGroupsCommandInput - {@link DescribeUserGroupsCommandInput}
@@ -50,6 +77,8 @@ export interface DescribeUserGroupsCommandOutput extends DescribeUserGroupsResul
50
77
  * @throws {@link UserGroupNotFoundFault} (client fault)
51
78
  * <p>The user group was not found or does not exist</p>
52
79
  *
80
+ * @throws {@link ElastiCacheServiceException}
81
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
53
82
  *
54
83
  */
55
84
  export declare class DescribeUserGroupsCommand extends $Command<DescribeUserGroupsCommandInput, DescribeUserGroupsCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -42,6 +42,28 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResult, __Metad
42
42
  * };
43
43
  * const command = new DescribeUsersCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // DescribeUsersResult
46
+ * // Users: [ // UserList
47
+ * // { // User
48
+ * // UserId: "STRING_VALUE",
49
+ * // UserName: "STRING_VALUE",
50
+ * // Status: "STRING_VALUE",
51
+ * // Engine: "STRING_VALUE",
52
+ * // MinimumEngineVersion: "STRING_VALUE",
53
+ * // AccessString: "STRING_VALUE",
54
+ * // UserGroupIds: [ // UserGroupIdList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // Authentication: { // Authentication
58
+ * // Type: "password" || "no-password" || "iam",
59
+ * // PasswordCount: Number("int"),
60
+ * // },
61
+ * // ARN: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // Marker: "STRING_VALUE",
65
+ * // };
66
+ *
45
67
  * ```
46
68
  *
47
69
  * @param DescribeUsersCommandInput - {@link DescribeUsersCommandInput}
@@ -59,6 +81,8 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResult, __Metad
59
81
  * @throws {@link UserNotFoundFault} (client fault)
60
82
  * <p>The user does not exist or could not be found.</p>
61
83
  *
84
+ * @throws {@link ElastiCacheServiceException}
85
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
62
86
  *
63
87
  */
64
88
  export declare class DescribeUsersCommand extends $Command<DescribeUsersCommandInput, DescribeUsersCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -33,6 +33,37 @@ export interface DisassociateGlobalReplicationGroupCommandOutput extends Disasso
33
33
  * };
34
34
  * const command = new DisassociateGlobalReplicationGroupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DisassociateGlobalReplicationGroupResult
37
+ * // GlobalReplicationGroup: { // GlobalReplicationGroup
38
+ * // GlobalReplicationGroupId: "STRING_VALUE",
39
+ * // GlobalReplicationGroupDescription: "STRING_VALUE",
40
+ * // Status: "STRING_VALUE",
41
+ * // CacheNodeType: "STRING_VALUE",
42
+ * // Engine: "STRING_VALUE",
43
+ * // EngineVersion: "STRING_VALUE",
44
+ * // Members: [ // GlobalReplicationGroupMemberList
45
+ * // { // GlobalReplicationGroupMember
46
+ * // ReplicationGroupId: "STRING_VALUE",
47
+ * // ReplicationGroupRegion: "STRING_VALUE",
48
+ * // Role: "STRING_VALUE",
49
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
50
+ * // Status: "STRING_VALUE",
51
+ * // },
52
+ * // ],
53
+ * // ClusterEnabled: true || false,
54
+ * // GlobalNodeGroups: [ // GlobalNodeGroupList
55
+ * // { // GlobalNodeGroup
56
+ * // GlobalNodeGroupId: "STRING_VALUE",
57
+ * // Slots: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // AuthTokenEnabled: true || false,
61
+ * // TransitEncryptionEnabled: true || false,
62
+ * // AtRestEncryptionEnabled: true || false,
63
+ * // ARN: "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
36
67
  * ```
37
68
  *
38
69
  * @param DisassociateGlobalReplicationGroupCommandInput - {@link DisassociateGlobalReplicationGroupCommandInput}
@@ -53,6 +84,8 @@ export interface DisassociateGlobalReplicationGroupCommandOutput extends Disasso
53
84
  * @throws {@link InvalidParameterValueException} (client fault)
54
85
  * <p>The value for a parameter is invalid.</p>
55
86
  *
87
+ * @throws {@link ElastiCacheServiceException}
88
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
56
89
  *
57
90
  */
58
91
  export declare class DisassociateGlobalReplicationGroupCommand extends $Command<DisassociateGlobalReplicationGroupCommandInput, DisassociateGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {