CDP Beta API Documentation 0.9.126

cloudera · Nov 14, 2024 · 70a3ba1 · 70a3ba1
1 parent 0106408
commit 70a3ba1
Show file tree

Hide file tree

Showing 41 changed files with 4,082 additions and 1,361 deletions.
diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md
@@ -1,5 +1,15 @@
 # CDP Control Plane Public API Changelog
 
+## 0.9.126 (2024-11-13)
+* cloudprivatelinks: Add properties `subscriptionId` and `cloudServiceProvider` to `AuthorizePrivateLinkServiceAccessRequest` and `RevokePrivateLinkServiceAccessRequest` objects.
+* datahub: Change description of property `type` in  `Recipe`, `RecipeSummary` and `CreateRecipeRequest` objects.
+* dw: Deprecate properties `dbDas` and `dbHue` in `PrivateCloudActivationOptions` object.
+* dw: Deprecate properties `dbMetastore`, `dbDas` and `dbHue` in `CreateDbcRequest` object.
+* dw: Deprecate property `securityContextConstraintName` in `CreatePrivateClusterRequest` and `PrivateCloudActivationOptions` objects.
+* environments: Deprecate property `s3GuardTableName` in `CreateAWSEnvironmentRequest`, `CreateAWSGovCloudEnvironmentRequest` and `Environment` object’s `awsDetails` objects.
+* environments: Add new command `lastSyncStatus`.
+* replicationmanager: Add new properties `clusterCrn`, `requestId`, `message` and `status` to `ActivatePolicyResponse`, `CreatePolicyResponse`, `DeletePolicyResponse` and `SuspendPolicyResponse` objects.
+
 ## 0.9.125 (2024-10-30)
 * datalake: Add new object 'DiskOptions' to 'StartDatalakeVerticalScalingRequest' & 'startDatalakeVerticalScaling' object.
 * datalake: Add new object 'AddDisks', 'ModifyDisks' to 'DiskOptions' object.

diff --git a/api-docs-beta/README.md b/api-docs-beta/README.md
@@ -1,30 +1,30 @@
 # CDP Control Plane Public API Documentation
 
-*Version: 0.9.125 (BETA)*
+*Version: 0.9.126 (BETA)*
 
 Available documentation is listed by service below.
 
 | Service | Version |
 | --- | --- |
-| [audit](./audit/index.html) | 0.9.125 |
-| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.125 |
-| [compute](./compute/index.html) | 0.9.125 |
-| [consumption](./consumption/index.html) | 0.9.125 |
-| [datacatalog](./datacatalog/index.html) | 0.9.125 |
-| [datahub](./datahub/index.html) | 0.9.125 |
-| [datalake](./datalake/index.html) | 0.9.125 |
-| [de](./de/index.html) | 0.9.125 |
-| [df](./df/index.html) | 0.9.125 |
-| [dfworkload](./dfworkload/index.html) | 0.9.125 |
-| [drscp](./drscp/index.html) | 0.9.125 |
-| [dw](./dw/index.html) | 0.9.125 |
-| [environments](./environments/index.html) | 0.9.125 |
-| [iam](./iam/index.html) | 0.9.125 |
-| [imagecatalog](./imagecatalog/index.html) | 0.9.125 |
-| [metrics](./metrics/index.html) | 0.9.125 |
-| [ml](./ml/index.html) | 0.9.125 |
-| [opdb](./opdb/index.html) | 0.9.125 |
-| [replicationmanager](./replicationmanager/index.html) | 0.9.125 |
+| [audit](./audit/index.html) | 0.9.126 |
+| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.126 |
+| [compute](./compute/index.html) | 0.9.126 |
+| [consumption](./consumption/index.html) | 0.9.126 |
+| [datacatalog](./datacatalog/index.html) | 0.9.126 |
+| [datahub](./datahub/index.html) | 0.9.126 |
+| [datalake](./datalake/index.html) | 0.9.126 |
+| [de](./de/index.html) | 0.9.126 |
+| [df](./df/index.html) | 0.9.126 |
+| [dfworkload](./dfworkload/index.html) | 0.9.126 |
+| [drscp](./drscp/index.html) | 0.9.126 |
+| [dw](./dw/index.html) | 0.9.126 |
+| [environments](./environments/index.html) | 0.9.126 |
+| [iam](./iam/index.html) | 0.9.126 |
+| [imagecatalog](./imagecatalog/index.html) | 0.9.126 |
+| [metrics](./metrics/index.html) | 0.9.126 |
+| [ml](./ml/index.html) | 0.9.126 |
+| [opdb](./opdb/index.html) | 0.9.126 |
+| [replicationmanager](./replicationmanager/index.html) | 0.9.126 |
 
 API documentation uses the Adoc Riak stylesheet from
 [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins).

diff --git a/api-docs-beta/audit/index.html b/api-docs-beta/audit/index.html
@@ -822,7 +822,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -3910,7 +3910,7 @@ <h3 id="_markarchivebatchesassuccessfulresponse">MarkArchiveBatchesAsSuccessfulR
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/cloudprivatelinks/index.html b/api-docs-beta/cloudprivatelinks/index.html
@@ -775,7 +775,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -1526,14 +1526,26 @@ <h3 id="_authorizeprivatelinkserviceaccessrequest">AuthorizePrivateLinkServiceAc
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>Account ID to authorize access for PrivateLink.</p>
+<p>AWS account ID to authorize access for PrivateLink.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
 </div></div></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><strong>cloudServiceProvider</strong><br>
+<em>optional</em></p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Cloud Service Provider. Currently supporting AWS and AZURE.</p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><a href="#_cloudserviceprovider">CloudServiceProvider</a></p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><strong>region</strong><br>
 <em>optional</em></p>
 </div></div></td>
@@ -1556,6 +1568,18 @@ <h3 id="_authorizeprivatelinkserviceaccessrequest">AuthorizePrivateLinkServiceAc
 <p>string</p>
 </div></div></td>
 </tr>
+<tr>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><strong>subscriptionId</strong><br>
+<em>optional</em></p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Azure subscription ID to authorize access for PrivateLink.</p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>string</p>
+</div></div></td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -2592,14 +2616,26 @@ <h3 id="_revokeprivatelinkserviceaccessrequest">RevokePrivateLinkServiceAccessRe
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>Account ID to revoke access for PrivateLink.</p>
+<p>AWS account ID to authorize access for PrivateLink.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
 </div></div></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><strong>cloudServiceProvider</strong><br>
+<em>optional</em></p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Cloud Service Provider. Currently supporting AWS and AZURE.</p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><a href="#_cloudserviceprovider">CloudServiceProvider</a></p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p><strong>region</strong><br>
 <em>optional</em></p>
 </div></div></td>
@@ -2622,6 +2658,18 @@ <h3 id="_revokeprivatelinkserviceaccessrequest">RevokePrivateLinkServiceAccessRe
 <p>string</p>
 </div></div></td>
 </tr>
+<tr>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p><strong>subscriptionId</strong><br>
+<em>optional</em></p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>Azure subscription ID to authorize access for PrivateLink.</p>
+</div></div></td>
+<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
+<p>string</p>
+</div></div></td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -2734,7 +2782,7 @@ <h3 id="_revokeprivatelinkserviceaccessresult">RevokePrivateLinkServiceAccessRes
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html
@@ -920,7 +920,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -5221,24 +5221,12 @@ <h3 id="_commonsecretencryption">CommonSecretEncryption</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The KMS key ARN used.</p>
+<p>AWS KMS key ARN.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
 </div></div></td>
 </tr>
-<tr>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p><strong>enabled</strong><br>
-<em>optional</em></p>
-</div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>Flag to enable secret encryption (default true). Deprecated.</p>
-</div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>boolean</p>
-</div></div></td>
-</tr>
 </tbody>
 </table>
 </div>
@@ -5267,24 +5255,12 @@ <h3 id="_commonsecretencryptionresp">CommonSecretEncryptionResp</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The KMS key ARN used.</p>
+<p>AWS KMS key ARN.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
 </div></div></td>
 </tr>
-<tr>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p><strong>enabled</strong><br>
-<em>optional</em></p>
-</div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>Flag to indicate if secret encryption is enabled.</p>
-</div></div></td>
-<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>boolean</p>
-</div></div></td>
-</tr>
 </tbody>
 </table>
 </div>
@@ -5763,7 +5739,7 @@ <h3 id="_commonvolumeencryptionresp">CommonVolumeEncryptionResp</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The KMS key ARN used.</p>
+<p>AWS KMS key ARN.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
@@ -10100,7 +10076,7 @@ <h3 id="_validationsummary">ValidationSummary</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/consumption/index.html b/api-docs-beta/consumption/index.html
@@ -720,7 +720,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -1259,7 +1259,7 @@ <h3 id="_listcomputeusagerecordsresponse">ListComputeUsageRecordsResponse</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/datacatalog/index.html b/api-docs-beta/datacatalog/index.html
@@ -721,7 +721,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -1220,7 +1220,7 @@ <h3 id="_launchprofilersresponse">LaunchProfilersResponse</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html
@@ -1406,7 +1406,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -12022,7 +12022,7 @@ <h3 id="_createreciperequest">CreateRecipeRequest</h3>
 <em>required</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.</p>
+<p>The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
@@ -17214,7 +17214,7 @@ <h3 id="_recipe">Recipe</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.</p>
+<p>The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
@@ -17284,7 +17284,7 @@ <h3 id="_recipesummary">RecipeSummary</h3>
 <em>optional</em></p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
-<p>The type of recipe. Supported values are : PRE_CLOUDERA_MANAGER_START, PRE_TERMINATION, POST_CLOUDERA_MANAGER_START, POST_CLUSTER_INSTALL.</p>
+<p>The type of recipe. Supported values are : PRE_SERVICE_DEPLOYMENT, PRE_TERMINATION, POST_SERVICE_DEPLOYMENT, POST_CLOUDERA_MANAGER_START.</p>
 </div></div></td>
 <td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
 <p>string</p>
@@ -19259,7 +19259,7 @@ <h3 id="_volumeencryptionrequest">VolumeEncryptionRequest</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html
@@ -1240,7 +1240,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -14925,7 +14925,7 @@ <h3 id="_validateazurecloudstorageresponse">ValidateAzureCloudStorageResponse</h
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>

diff --git a/api-docs-beta/de/index.html b/api-docs-beta/de/index.html
@@ -915,7 +915,7 @@ <h2 id="_overview">Overview</h2>
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 0.9.125 (BETA)</p>
+<p><em>Version</em> : 0.9.126 (BETA)</p>
 </div>
 </div>
 <div class="sect2">
@@ -7494,7 +7494,7 @@ <h3 id="_vcsummary">VcSummary</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-31 09:33:35 -0700
+Last updated 2024-11-13 12:37:13 -0800
 </div>
 </div>
 <br>