|
230 | 230 | ],
|
231 | 231 | "documentation":"<p>Deletes a kdb cluster.</p>"
|
232 | 232 | },
|
| 233 | + "DeleteKxClusterNode":{ |
| 234 | + "name":"DeleteKxClusterNode", |
| 235 | + "http":{ |
| 236 | + "method":"DELETE", |
| 237 | + "requestUri":"/kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}" |
| 238 | + }, |
| 239 | + "input":{"shape":"DeleteKxClusterNodeRequest"}, |
| 240 | + "output":{"shape":"DeleteKxClusterNodeResponse"}, |
| 241 | + "errors":[ |
| 242 | + {"shape":"InternalServerException"}, |
| 243 | + {"shape":"ThrottlingException"}, |
| 244 | + {"shape":"AccessDeniedException"}, |
| 245 | + {"shape":"ValidationException"}, |
| 246 | + {"shape":"ResourceNotFoundException"} |
| 247 | + ], |
| 248 | + "documentation":"<p>Deletes the specified nodes from a cluster. </p>" |
| 249 | + }, |
233 | 250 | "DeleteKxDatabase":{
|
234 | 251 | "name":"DeleteKxDatabase",
|
235 | 252 | "http":{
|
|
1176 | 1193 | },
|
1177 | 1194 | "changeRequests":{
|
1178 | 1195 | "shape":"ChangeRequests",
|
1179 |
| - "documentation":"<p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>. A changeType can has the following values: </p> <ul> <li> <p>PUT – Adds or updates files in a database.</p> </li> <li> <p>DELETE – Deletes files in a database.</p> </li> </ul> <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is a directory and must end without a trailing / if it is a file. </p> <p>Here are few examples of how you can use the change request object:</p> <ol> <li> <p>This request adds a single sym file at database root location. </p> <p> <code>{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\", \"dbPath\":\"/\"}</code> </p> </li> <li> <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02 partition of the database.</p> <p> <code>{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"}</code> </p> </li> <li> <p>This request adds files in the given <code>s3Path</code> under the <i>taq</i> table partition of the database.</p> <p> <code>[ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]</code> </p> </li> <li> <p>This request deletes the 2020.01.02 partition of the database.</p> <p> <code>[{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]</code> </p> </li> <li> <p>The <i>DELETE</i> request allows you to delete the existing files under the 2020.01.02 partition of the database, and the <i>PUT</i> request adds a new taq table under it.</p> <p> <code>[ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]</code> </p> </li> </ol>" |
| 1196 | + "documentation":"<p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>. A changeType can have the following values: </p> <ul> <li> <p>PUT – Adds or updates files in a database.</p> </li> <li> <p>DELETE – Deletes files in a database.</p> </li> </ul> <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is a directory and must end without a trailing / if it is a file. </p> <p>Here are few examples of how you can use the change request object:</p> <ol> <li> <p>This request adds a single sym file at database root location. </p> <p> <code>{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\", \"dbPath\":\"/\"}</code> </p> </li> <li> <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02 partition of the database.</p> <p> <code>{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"}</code> </p> </li> <li> <p>This request adds files in the given <code>s3Path</code> under the <i>taq</i> table partition of the database.</p> <p> <code>[ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]</code> </p> </li> <li> <p>This request deletes the 2020.01.02 partition of the database.</p> <p> <code>[{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]</code> </p> </li> <li> <p>The <i>DELETE</i> request allows you to delete the existing files under the 2020.01.02 partition of the database, and the <i>PUT</i> request adds a new taq table under it.</p> <p> <code>[ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]</code> </p> </li> </ol>" |
1180 | 1197 | },
|
1181 | 1198 | "clientToken":{
|
1182 | 1199 | "shape":"ClientTokenString",
|
|
1960 | 1977 | "members":{
|
1961 | 1978 | }
|
1962 | 1979 | },
|
| 1980 | + "DeleteKxClusterNodeRequest":{ |
| 1981 | + "type":"structure", |
| 1982 | + "required":[ |
| 1983 | + "clusterName", |
| 1984 | + "nodeId", |
| 1985 | + "environmentId" |
| 1986 | + ], |
| 1987 | + "members":{ |
| 1988 | + "environmentId":{ |
| 1989 | + "shape":"KxEnvironmentId", |
| 1990 | + "documentation":"<p>A unique identifier for the kdb environment.</p>", |
| 1991 | + "location":"uri", |
| 1992 | + "locationName":"environmentId" |
| 1993 | + }, |
| 1994 | + "clusterName":{ |
| 1995 | + "shape":"KxClusterName", |
| 1996 | + "documentation":"<p>The name of the cluster, for which you want to delete the nodes.</p>", |
| 1997 | + "location":"uri", |
| 1998 | + "locationName":"clusterName" |
| 1999 | + }, |
| 2000 | + "nodeId":{ |
| 2001 | + "shape":"KxClusterNodeIdString", |
| 2002 | + "documentation":"<p>A unique identifier for the node that you want to delete.</p>", |
| 2003 | + "location":"uri", |
| 2004 | + "locationName":"nodeId" |
| 2005 | + } |
| 2006 | + } |
| 2007 | + }, |
| 2008 | + "DeleteKxClusterNodeResponse":{ |
| 2009 | + "type":"structure", |
| 2010 | + "members":{ |
| 2011 | + } |
| 2012 | + }, |
1963 | 2013 | "DeleteKxClusterRequest":{
|
1964 | 2014 | "type":"structure",
|
1965 | 2015 | "required":[
|
|
3751 | 3801 | },
|
3752 | 3802 | "size":{
|
3753 | 3803 | "shape":"KxNAS1Size",
|
3754 |
| - "documentation":"<p> The size of the network attached storage.</p>" |
| 3804 | + "documentation":"<p> The size of the network attached storage. For storage type <code>SSD_1000</code> and <code>SSD_250</code> you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type <code>HDD_12</code> you can select the minimum size as 6000 GB or increments of 6000 GB.</p>" |
3755 | 3805 | }
|
3756 | 3806 | },
|
3757 | 3807 | "documentation":"<p> The structure containing the size and type of the network attached storage (NAS_1) file system volume. </p>"
|
|
3782 | 3832 | "launchTime":{
|
3783 | 3833 | "shape":"Timestamp",
|
3784 | 3834 | "documentation":"<p>The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
|
| 3835 | + }, |
| 3836 | + "status":{ |
| 3837 | + "shape":"KxNodeStatus", |
| 3838 | + "documentation":"<p> Specifies the status of the cluster nodes. </p> <ul> <li> <p> <code>RUNNING</code> – The node is actively serving.</p> </li> <li> <p> <code>PROVISIONING</code> – The node is being prepared.</p> </li> </ul>" |
3785 | 3839 | }
|
3786 | 3840 | },
|
3787 | 3841 | "documentation":"<p>A structure that stores metadata for a kdb node.</p>"
|
3788 | 3842 | },
|
| 3843 | + "KxNodeStatus":{ |
| 3844 | + "type":"string", |
| 3845 | + "enum":[ |
| 3846 | + "RUNNING", |
| 3847 | + "PROVISIONING" |
| 3848 | + ] |
| 3849 | + }, |
3789 | 3850 | "KxNodeSummaries":{
|
3790 | 3851 | "type":"list",
|
3791 | 3852 | "member":{"shape":"KxNode"}
|
|
0 commit comments