@aws-sdk/client-elasticache 3.775.0 → 3.777.0

package/dist-types/commands/DescribeCacheClustersCommand.d.ts

@@ -196,49 +196,115 @@ declare const DescribeCacheClustersCommand_base: {
  * @throws {@link ElastiCacheServiceException}
  * <p>Base exception class for all service exceptions from ElastiCache service.</p>
  *
- * @public
+ *
+ * @example DescribeCacheClusters
+ * ```javascript
+ * // Lists the details for the cache cluster my-mem-cluster.
+ * const input = {
+ *   CacheClusterId: "my-mem-cluster",
+ *   ShowCacheNodeInfo: true
+ * };
+ * const command = new DescribeCacheClustersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   CacheClusters: [
+ *     {
+ *       AutoMinorVersionUpgrade: true,
+ *       CacheClusterCreateTime: "2016-12-21T21:59:43.794Z",
+ *       CacheClusterId: "my-mem-cluster",
+ *       CacheClusterStatus: "available",
+ *       CacheNodeType: "cache.t2.medium",
+ *       CacheNodes: [
+ *         {
+ *           CacheNodeCreateTime: "2016-12-21T21:59:43.794Z",
+ *           CacheNodeId: "0001",
+ *           CacheNodeStatus: "available",
+ *           CustomerAvailabilityZone: "us-east-1b",
+ *           Endpoint: {
+ *             Address: "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com",
+ *             Port: 11211
+ *           },
+ *           ParameterGroupStatus: "in-sync"
+ *         },
+ *         {
+ *           CacheNodeCreateTime: "2016-12-21T21:59:43.794Z",
+ *           CacheNodeId: "0002",
+ *           CacheNodeStatus: "available",
+ *           CustomerAvailabilityZone: "us-east-1a",
+ *           Endpoint: {
+ *             Address: "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com",
+ *             Port: 11211
+ *           },
+ *           ParameterGroupStatus: "in-sync"
+ *         }
+ *       ],
+ *       CacheParameterGroup: {
+ *         CacheNodeIdsToReboot:         [],
+ *         CacheParameterGroupName: "default.memcached1.4",
+ *         ParameterApplyStatus: "in-sync"
+ *       },
+ *       CacheSecurityGroups:       [],
+ *       CacheSubnetGroupName: "default",
+ *       ClientDownloadLandingPage: "https://console.aws.amazon.com/elasticache/home#client-download:",
+ *       ConfigurationEndpoint: {
+ *         Address: "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com",
+ *         Port: 11211
+ *       },
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.24",
+ *       NumCacheNodes: 2,
+ *       PendingModifiedValues:       { /* empty *\/ },
+ *       PreferredAvailabilityZone: "Multiple",
+ *       PreferredMaintenanceWindow: "wed:06:00-wed:07:00"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @example DescribeCacheClusters
  * ```javascript
  * // Lists the details for up to 50 cache clusters.
  * const input = {
- *   "CacheClusterId": "my-mem-cluster"
+ *   CacheClusterId: "my-mem-cluster"
  * };
  * const command = new DescribeCacheClustersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CacheClusters": [
+ *   CacheClusters: [
  *     {
- *       "AutoMinorVersionUpgrade": true,
- *       "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z",
- *       "CacheClusterId": "my-mem-cluster",
- *       "CacheClusterStatus": "available",
- *       "CacheNodeType": "cache.t2.medium",
- *       "CacheParameterGroup": {
- *         "CacheNodeIdsToReboot": [],
- *         "CacheParameterGroupName": "default.memcached1.4",
- *         "ParameterApplyStatus": "in-sync"
+ *       AutoMinorVersionUpgrade: true,
+ *       CacheClusterCreateTime: "2016-12-21T21:59:43.794Z",
+ *       CacheClusterId: "my-mem-cluster",
+ *       CacheClusterStatus: "available",
+ *       CacheNodeType: "cache.t2.medium",
+ *       CacheParameterGroup: {
+ *         CacheNodeIdsToReboot:         [],
+ *         CacheParameterGroupName: "default.memcached1.4",
+ *         ParameterApplyStatus: "in-sync"
  *       },
- *       "CacheSecurityGroups": [],
- *       "CacheSubnetGroupName": "default",
- *       "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
- *       "ConfigurationEndpoint": {
- *         "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com",
- *         "Port": 11211
+ *       CacheSecurityGroups:       [],
+ *       CacheSubnetGroupName: "default",
+ *       ClientDownloadLandingPage: "https://console.aws.amazon.com/elasticache/home#client-download:",
+ *       ConfigurationEndpoint: {
+ *         Address: "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com",
+ *         Port: 11211
  *       },
- *       "Engine": "memcached",
- *       "EngineVersion": "1.4.24",
- *       "NumCacheNodes": 2,
- *       "PendingModifiedValues": {},
- *       "PreferredAvailabilityZone": "Multiple",
- *       "PreferredMaintenanceWindow": "wed:06:00-wed:07:00"
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.24",
+ *       NumCacheNodes: 2,
+ *       PendingModifiedValues:       { /* empty *\/ },
+ *       PreferredAvailabilityZone: "Multiple",
+ *       PreferredMaintenanceWindow: "wed:06:00-wed:07:00"
  *     }
  *   ]
  * }
  * *\/
- * // example id: describecacheclusters-1475012269754
  * ```
  *
+ * @public
  */
 export declare class DescribeCacheClustersCommand extends DescribeCacheClustersCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts

@@ -68,106 +68,181 @@ declare const DescribeCacheEngineVersionsCommand_base: {
  * @throws {@link ElastiCacheServiceException}
  * <p>Base exception class for all service exceptions from ElastiCache service.</p>
  *
- * @public
+ *
  * @example DescribeCacheEngineVersions
  * ```javascript
  * // Lists the details for up to 25 Memcached and Redis cache engine versions.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DescribeCacheEngineVersionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CacheEngineVersions": [
+ *   CacheEngineVersions: [
  *     {
- *       "CacheEngineDescription": "memcached",
- *       "CacheEngineVersionDescription": "memcached version 1.4.14",
- *       "CacheParameterGroupFamily": "memcached1.4",
- *       "Engine": "memcached",
- *       "EngineVersion": "1.4.14"
+ *       CacheEngineDescription: "memcached",
+ *       CacheEngineVersionDescription: "memcached version 1.4.14",
+ *       CacheParameterGroupFamily: "memcached1.4",
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.14"
  *     },
  *     {
- *       "CacheEngineDescription": "memcached",
- *       "CacheEngineVersionDescription": "memcached version 1.4.24",
- *       "CacheParameterGroupFamily": "memcached1.4",
- *       "Engine": "memcached",
- *       "EngineVersion": "1.4.24"
+ *       CacheEngineDescription: "memcached",
+ *       CacheEngineVersionDescription: "memcached version 1.4.24",
+ *       CacheParameterGroupFamily: "memcached1.4",
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.24"
  *     },
  *     {
- *       "CacheEngineDescription": "memcached",
- *       "CacheEngineVersionDescription": "memcached version 1.4.33",
- *       "CacheParameterGroupFamily": "memcached1.4",
- *       "Engine": "memcached",
- *       "EngineVersion": "1.4.33"
+ *       CacheEngineDescription: "memcached",
+ *       CacheEngineVersionDescription: "memcached version 1.4.33",
+ *       CacheParameterGroupFamily: "memcached1.4",
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.33"
  *     },
  *     {
- *       "CacheEngineDescription": "memcached",
- *       "CacheEngineVersionDescription": "memcached version 1.4.5",
- *       "CacheParameterGroupFamily": "memcached1.4",
- *       "Engine": "memcached",
- *       "EngineVersion": "1.4.5"
+ *       CacheEngineDescription: "memcached",
+ *       CacheEngineVersionDescription: "memcached version 1.4.5",
+ *       CacheParameterGroupFamily: "memcached1.4",
+ *       Engine: "memcached",
+ *       EngineVersion: "1.4.5"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.6.13",
- *       "CacheParameterGroupFamily": "redis2.6",
- *       "Engine": "redis",
- *       "EngineVersion": "2.6.13"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.6.13",
+ *       CacheParameterGroupFamily: "redis2.6",
+ *       Engine: "redis",
+ *       EngineVersion: "2.6.13"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.19",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.19"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.19",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.19"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.21",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.21"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.21",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.21"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.22 R5",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.22"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.22 R5",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.22"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.23 R4",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.23"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.23 R4",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.23"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.24 R3",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.24"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.24 R3",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.24"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 2.8.6",
- *       "CacheParameterGroupFamily": "redis2.8",
- *       "Engine": "redis",
- *       "EngineVersion": "2.8.6"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.6",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.6"
  *     },
  *     {
- *       "CacheEngineDescription": "Redis",
- *       "CacheEngineVersionDescription": "redis version 3.2.4",
- *       "CacheParameterGroupFamily": "redis3.2",
- *       "Engine": "redis",
- *       "EngineVersion": "3.2.4"
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 3.2.4",
+ *       CacheParameterGroupFamily: "redis3.2",
+ *       Engine: "redis",
+ *       EngineVersion: "3.2.4"
  *     }
  *   ]
  * }
  * *\/
- * // example id: describecacheengineversions-1475012638790
  * ```
  *
+ * @example DescribeCacheEngineVersions
+ * ```javascript
+ * // Lists the details for up to 50 Redis cache engine versions.
+ * const input = {
+ *   DefaultOnly: false,
+ *   Engine: "redis",
+ *   MaxRecords: 50
+ * };
+ * const command = new DescribeCacheEngineVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   CacheEngineVersions: [
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.6.13",
+ *       CacheParameterGroupFamily: "redis2.6",
+ *       Engine: "redis",
+ *       EngineVersion: "2.6.13"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.19",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.19"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.21",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.21"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.22 R5",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.22"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.23 R4",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.23"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.24 R3",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.24"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 2.8.6",
+ *       CacheParameterGroupFamily: "redis2.8",
+ *       Engine: "redis",
+ *       EngineVersion: "2.8.6"
+ *     },
+ *     {
+ *       CacheEngineDescription: "Redis",
+ *       CacheEngineVersionDescription: "redis version 3.2.4",
+ *       CacheParameterGroupFamily: "redis3.2",
+ *       Engine: "redis",
+ *       EngineVersion: "3.2.4"
+ *     }
+ *   ],
+ *   Marker: ""
+ * }
+ * *\/
+ * ```
+ *
+ * @public
  */
 export declare class DescribeCacheEngineVersionsCommand extends DescribeCacheEngineVersionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts

@@ -76,29 +76,29 @@ declare const DescribeCacheParameterGroupsCommand_base: {
  * @throws {@link ElastiCacheServiceException}
  * <p>Base exception class for all service exceptions from ElastiCache service.</p>
  *
- * @public
+ *
  * @example DescribeCacheParameterGroups
  * ```javascript
  * // Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
  * const input = {
- *   "CacheParameterGroupName": "custom-mem1-4"
+ *   CacheParameterGroupName: "custom-mem1-4"
  * };
  * const command = new DescribeCacheParameterGroupsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CacheParameterGroups": [
+ *   CacheParameterGroups: [
  *     {
- *       "CacheParameterGroupFamily": "memcached1.4",
- *       "CacheParameterGroupName": "custom-mem1-4",
- *       "Description": "Custom memcache param group"
+ *       CacheParameterGroupFamily: "memcached1.4",
+ *       CacheParameterGroupName: "custom-mem1-4",
+ *       Description: "Custom memcache param group"
  *     }
  *   ]
  * }
  * *\/
- * // example id: describecacheparametergroups-1483045457557
  * ```
  *
+ * @public
  */
 export declare class DescribeCacheParameterGroupsCommand extends DescribeCacheParameterGroupsCommand_base {
     /** @internal type navigation helper, not in runtime. */