docs(client-neptunedata): Doc changes to add IAM action mappings for …

…the data actions.
aws · Oct 19, 2023 · 4466174 · 4466174
1 parent c86d343
commit 4466174
Show file tree

Hide file tree

Showing 45 changed files with 391 additions and 107 deletions.
diff --git a/clients/client-neptunedata/src/commands/CancelGremlinQueryCommand.ts b/clients/client-neptunedata/src/commands/CancelGremlinQueryCommand.ts
@@ -39,6 +39,10 @@ export interface CancelGremlinQueryCommandOutput extends CancelGremlinQueryOutpu
  * @public
  * <p>Cancels a Gremlin query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html">Gremlin
  *       query cancellation</a> for more information.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CancelLoaderJobCommand.ts b/clients/client-neptunedata/src/commands/CancelLoaderJobCommand.ts
@@ -38,9 +38,12 @@ export interface CancelLoaderJobCommandOutput extends CancelLoaderJobOutput, __M
 /**
  * @public
  * <p>Cancels a specified load job. This is an HTTP <code>DELETE</code>
- *       request.</p>
- *          <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
+ *       request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
  *       Loader Get-Status API</a> for more information.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob">neptune-db:CancelLoaderJob</a>
+ *       IAM action in that cluster..</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CancelMLDataProcessingJobCommand.ts b/clients/client-neptunedata/src/commands/CancelMLDataProcessingJobCommand.ts
@@ -39,6 +39,10 @@ export interface CancelMLDataProcessingJobCommandOutput extends CancelMLDataProc
  * @public
  * <p>Cancels a Neptune ML data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The
  *       <code>dataprocessing</code> command</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob">neptune-db:CancelMLDataProcessingJob</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CancelMLModelTrainingJobCommand.ts b/clients/client-neptunedata/src/commands/CancelMLModelTrainingJobCommand.ts
@@ -39,6 +39,10 @@ export interface CancelMLModelTrainingJobCommandOutput extends CancelMLModelTrai
  * @public
  * <p>Cancels a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model
  *       training using the <code>modeltraining</code> command</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob">neptune-db:CancelMLModelTrainingJob</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CancelMLModelTransformJobCommand.ts b/clients/client-neptunedata/src/commands/CancelMLModelTransformJobCommand.ts
@@ -39,6 +39,10 @@ export interface CancelMLModelTransformJobCommandOutput extends CancelMLModelTra
  * @public
  * <p>Cancels a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
  *       a trained model to generate new model artifacts</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob">neptune-db:CancelMLModelTransformJob</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CancelOpenCypherQueryCommand.ts b/clients/client-neptunedata/src/commands/CancelOpenCypherQueryCommand.ts
@@ -39,6 +39,10 @@ export interface CancelOpenCypherQueryCommandOutput extends CancelOpenCypherQuer
  * @public
  * <p>Cancels a specified openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune
  *       openCypher status endpoint</a> for more information.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/CreateMLEndpointCommand.ts b/clients/client-neptunedata/src/commands/CreateMLEndpointCommand.ts
@@ -41,6 +41,10 @@ export interface CreateMLEndpointCommandOutput extends CreateMLEndpointOutput, _
  *       one specific model that the model-training process constructed. See
  *       <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
  *       inference endpoints using the endpoints command</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint">neptune-db:CreateMLEndpoint</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/DeleteMLEndpointCommand.ts b/clients/client-neptunedata/src/commands/DeleteMLEndpointCommand.ts
@@ -40,6 +40,10 @@ export interface DeleteMLEndpointCommandOutput extends DeleteMLEndpointOutput, _
  * <p>Cancels the creation of a Neptune ML inference endpoint. See
  *       <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
  *       inference endpoints using the endpoints command</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint">neptune-db:DeleteMLEndpoint</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/DeletePropertygraphStatisticsCommand.ts b/clients/client-neptunedata/src/commands/DeletePropertygraphStatisticsCommand.ts
@@ -44,6 +44,10 @@ export interface DeletePropertygraphStatisticsCommandOutput
  * @public
  * <p>Deletes statistics for Gremlin and openCypher (property graph)
  *       data.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/DeleteSparqlStatisticsCommand.ts b/clients/client-neptunedata/src/commands/DeleteSparqlStatisticsCommand.ts
@@ -38,6 +38,10 @@ export interface DeleteSparqlStatisticsCommandOutput extends DeleteSparqlStatist
 /**
  * @public
  * <p>Deletes SPARQL statistics</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteFastResetCommand.ts b/clients/client-neptunedata/src/commands/ExecuteFastResetCommand.ts
@@ -44,6 +44,10 @@ export interface ExecuteFastResetCommandOutput extends ExecuteFastResetOutput, _
  *       UUID token which you then include when calling <code>ExecuteFastReset</code> again
  *       with <code>action</code> set to <code>performDatabaseReset</code>. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html">Empty an Amazon Neptune
  *       DB cluster using the fast reset API</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase">neptune-db:ResetDatabase</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteGremlinExplainQueryCommand.ts b/clients/client-neptunedata/src/commands/ExecuteGremlinExplainQueryCommand.ts
@@ -59,6 +59,31 @@ export interface ExecuteGremlinExplainQueryCommandOutput
  *       as explained  in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning
  *       Gremlin queries</a>. You can also use query hints to improve
  *       query execution plans.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows one of the following IAM actions
+ *       in that cluster, depending on the query:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteGremlinProfileQueryCommand.ts b/clients/client-neptunedata/src/commands/ExecuteGremlinProfileQueryCommand.ts
@@ -51,6 +51,14 @@ export interface ExecuteGremlinProfileQueryCommandOutput
  *       collects various metrics about the run, and produces a profile report
  *       as output. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile
  *       API in Neptune</a> for details.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
+ *       IAM action in that cluster.</p>
+ *          <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteGremlinQueryCommand.ts b/clients/client-neptunedata/src/commands/ExecuteGremlinQueryCommand.ts
@@ -43,6 +43,31 @@ export interface ExecuteGremlinQueryCommandOutput extends ExecuteGremlinQueryOut
  *       Graph</a> in the Apache TinkerPop3 documentation.
  *       More details can also be found in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html">Accessing a
  *       Neptune graph with Gremlin</a>.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that enables one of the following IAM actions
+ *       in that cluster, depending on the query:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteOpenCypherExplainQueryCommand.ts b/clients/client-neptunedata/src/commands/ExecuteOpenCypherExplainQueryCommand.ts
@@ -53,6 +53,14 @@ export interface ExecuteOpenCypherExplainQueryCommandOutput
  * <p>Executes an openCypher <code>explain</code> request. See
  *       <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The
  *       openCypher explain feature</a> for more information.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
+ *       IAM action in that cluster.</p>
+ *          <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Opencypher</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/ExecuteOpenCypherQueryCommand.ts b/clients/client-neptunedata/src/commands/ExecuteOpenCypherQueryCommand.ts
@@ -48,6 +48,31 @@ export interface ExecuteOpenCypherQueryCommandOutput extends ExecuteOpenCypherQu
  *          <p>The openCypher language was originally developed by Neo4j, then
  *       open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache
  *       2 open-source license.</p>
+ *          <p>Note that when invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows one of the following IAM actions
+ *       in that cluster, depending on the query:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Note also that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Opencypher</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/GetEngineStatusCommand.ts b/clients/client-neptunedata/src/commands/GetEngineStatusCommand.ts
@@ -37,7 +37,11 @@ export interface GetEngineStatusCommandOutput extends GetEngineStatusOutput, __M
 
 /**
  * @public
- * <p>Check the status of the graph database on the host.</p>
+ * <p>Retrieves the status of the graph database on the host.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus">neptune-db:GetEngineStatus</a>
+ *       IAM action in that cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/GetGremlinQueryStatusCommand.ts b/clients/client-neptunedata/src/commands/GetGremlinQueryStatusCommand.ts
@@ -38,6 +38,14 @@ export interface GetGremlinQueryStatusCommandOutput extends GetGremlinQueryStatu
 /**
  * @public
  * <p>Gets the status of a specified Gremlin query.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a>
+ *       IAM action in that cluster.</p>
+ *          <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
+ *       IAM condition key can be used in the policy document to restrict the use of
+ *       Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
+ *       keys available in Neptune IAM data-access policy statements</a>).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-neptunedata/src/commands/GetLoaderJobStatusCommand.ts b/clients/client-neptunedata/src/commands/GetLoaderJobStatusCommand.ts
@@ -42,6 +42,10 @@ export interface GetLoaderJobStatusCommandOutput extends GetLoaderJobStatusOutpu
  *       and stores the last 10,000 error details per job.</p>
  *          <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
  *       Loader Get-Status API</a> for more information.</p>
+ *          <p>When invoking this operation in a Neptune cluster that has IAM
+ *       authentication enabled, the IAM user or role making the request must
+ *       have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus">neptune-db:GetLoaderJobStatus</a>
+ *       IAM action in that cluster..</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript