docs(client-frauddetector): Documentation updates for Amazon Fraud De…

…tector (AWSHawksNest)
aws · Jun 10, 2022 · 8e77b11 · 8e77b11
1 parent 39318f2
commit 8e77b11
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 11 deletions.
diff --git a/clients/client-frauddetector/README.md b/clients/client-frauddetector/README.md
@@ -13,6 +13,13 @@ AWS SDK for JavaScript FraudDetector Client for Node.js, Browser and React Nativ
 detailed information about Amazon Fraud Detector API actions, data types, and errors. For
 more information about Amazon Fraud Detector features, see the <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/">Amazon Fraud Detector User Guide</a>.</p>
 
+<p>We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.</p>
+<p>The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter <code>Action</code>. AWS SDK provides libraries,
+sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over
+HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and
+handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see <a href="https://docs.aws.amazon.com/https:/aws.amazon.com/tools/">Tools to build on AWS</a>.
+</p>
+
 ## Installing
 
 To install the this package, simply type add or install @aws-sdk/client-frauddetector

diff --git a/clients/client-frauddetector/src/FraudDetector.ts b/clients/client-frauddetector/src/FraudDetector.ts
@@ -279,6 +279,13 @@ import { FraudDetectorClient } from "./FraudDetectorClient";
  * <p>This is the Amazon Fraud Detector API Reference. This guide is for developers who need
  *             detailed information about Amazon Fraud Detector API actions, data types, and errors. For
  *             more information about Amazon Fraud Detector features, see the <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/">Amazon Fraud Detector User Guide</a>.</p>
+ *
+ *         <p>We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.</p>
+ *         <p>The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter <code>Action</code>. AWS SDK provides libraries,
+ *             sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over
+ *             HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and
+ *             handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see <a href="https://docs.aws.amazon.com/https:/aws.amazon.com/tools/">Tools to build on AWS</a>.
+ *             </p>
  */
 export class FraudDetector extends FraudDetectorClient {
   /**
@@ -623,7 +630,7 @@ export class FraudDetector extends FraudDetectorClient {
   }
 
   /**
-   * <p>Deletes data that was batch imported to Amazon Fraud Detector. </p>
+   * <p>Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.  </p>
    */
   public deleteBatchImportJob(
     args: DeleteBatchImportJobCommandInput,
@@ -2310,6 +2317,9 @@ export class FraudDetector extends FraudDetectorClient {
    *          <p>You can perform the following status updates:</p>
    *          <ol>
    *             <li>
+   *                <p>Change the <code>TRAINING_IN_PROGRESS</code> status to <code>TRAINING_CANCELLED</code>.</p>
+   *             </li>
+   *             <li>
    *                <p>Change the <code>TRAINING_COMPLETE</code> status to <code>ACTIVE</code>.</p>
    *             </li>
    *             <li>

diff --git a/clients/client-frauddetector/src/FraudDetectorClient.ts b/clients/client-frauddetector/src/FraudDetectorClient.ts
@@ -489,6 +489,13 @@ export interface FraudDetectorClientResolvedConfig extends FraudDetectorClientRe
  * <p>This is the Amazon Fraud Detector API Reference. This guide is for developers who need
  *             detailed information about Amazon Fraud Detector API actions, data types, and errors. For
  *             more information about Amazon Fraud Detector features, see the <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/">Amazon Fraud Detector User Guide</a>.</p>
+ *
+ *         <p>We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.</p>
+ *         <p>The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter <code>Action</code>. AWS SDK provides libraries,
+ *             sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over
+ *             HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and
+ *             handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see <a href="https://docs.aws.amazon.com/https:/aws.amazon.com/tools/">Tools to build on AWS</a>.
+ *             </p>
  */
 export class FraudDetectorClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-frauddetector/src/commands/DeleteBatchImportJobCommand.ts b/clients/client-frauddetector/src/commands/DeleteBatchImportJobCommand.ts
@@ -23,7 +23,7 @@ export interface DeleteBatchImportJobCommandInput extends DeleteBatchImportJobRe
 export interface DeleteBatchImportJobCommandOutput extends DeleteBatchImportJobResult, __MetadataBearer {}
 
 /**
- * <p>Deletes data that was batch imported to Amazon Fraud Detector. </p>
+ * <p>Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.  </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-frauddetector/src/commands/UpdateModelVersionStatusCommand.ts b/clients/client-frauddetector/src/commands/UpdateModelVersionStatusCommand.ts
@@ -27,6 +27,9 @@ export interface UpdateModelVersionStatusCommandOutput extends UpdateModelVersio
  *          <p>You can perform the following status updates:</p>
  *          <ol>
  *             <li>
+ *                <p>Change the <code>TRAINING_IN_PROGRESS</code> status to <code>TRAINING_CANCELLED</code>.</p>
+ *             </li>
+ *             <li>
  *                <p>Change the <code>TRAINING_COMPLETE</code> status to <code>ACTIVE</code>.</p>
  *             </li>
  *             <li>

diff --git a/clients/client-frauddetector/src/models/models_0.ts b/clients/client-frauddetector/src/models/models_0.ts
@@ -2952,8 +2952,9 @@ export interface GetEventPredictionMetadataRequest {
 
   /**
    * <p>
-   * The timestamp that defines when the prediction was generated.
-   * </p>
+   *     The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.</p>
+   *          <p>We recommend calling <a href="https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html">ListEventPredictions</a>
+   *         first, and using the <code>predictionTimestamp</code> value in the response to provide an accurate prediction timestamp value.</p>
    */
   predictionTimestamp: string | undefined;
 }
@@ -3369,8 +3370,7 @@ export interface GetEventPredictionMetadataResult {
   evaluatedExternalModels?: EvaluatedExternalModel[];
 
   /**
-   * <p>The timestamp that defines when the prediction was generated.
-   * </p>
+   * <p>The timestamp that defines when the prediction was generated. </p>
    */
   predictionTimestamp?: string;
 }

diff --git a/codegen/sdk-codegen/aws-models/frauddetector.json b/codegen/sdk-codegen/aws-models/frauddetector.json
@@ -43,7 +43,7 @@
           "name": "frauddetector"
         },
         "aws.protocols#awsJson1_1": {},
-        "smithy.api#documentation": "<p>This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n            detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n            more information about Amazon Fraud Detector features, see the <a href=\"https://docs.aws.amazon.com/frauddetector/latest/ug/\">Amazon Fraud Detector User Guide</a>.</p>",
+        "smithy.api#documentation": "<p>This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n            detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n            more information about Amazon Fraud Detector features, see the <a href=\"https://docs.aws.amazon.com/frauddetector/latest/ug/\">Amazon Fraud Detector User Guide</a>.</p>\n        \n        <p>We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.</p>\n        <p>The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter <code>Action</code>. AWS SDK provides libraries, \n            sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over \n            HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and \n            handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see <a href=\"https://docs.aws.amazon.com/https:/aws.amazon.com/tools/\">Tools to build on AWS</a>.\n            </p>",
         "smithy.api#title": "Amazon Fraud Detector",
         "smithy.api#xmlNamespace": {
           "uri": "http://hawksnest.amazonaws.com/doc/2019-11-15"
@@ -1505,7 +1505,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Deletes data that was batch imported to Amazon Fraud Detector. </p>"
+        "smithy.api#documentation": "<p>Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.  </p>"
       }
     },
     "com.amazonaws.frauddetector#DeleteBatchImportJobRequest": {
@@ -3756,7 +3756,7 @@
         "predictionTimestamp": {
           "target": "com.amazonaws.frauddetector#time",
           "traits": {
-            "smithy.api#documentation": "<p>\nThe timestamp that defines when the prediction was generated. \n</p>",
+            "smithy.api#documentation": "<p>\n    The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.</p>\n         <p>We recommend calling <a href=\"https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html\">ListEventPredictions</a>\n        first, and using the <code>predictionTimestamp</code> value in the response to provide an accurate prediction timestamp value.</p>",
             "smithy.api#required": {}
           }
         }
@@ -3852,7 +3852,7 @@
         "predictionTimestamp": {
           "target": "com.amazonaws.frauddetector#time",
           "traits": {
-            "smithy.api#documentation": "<p>The timestamp that defines when the prediction was generated.\n</p>"
+            "smithy.api#documentation": "<p>The timestamp that defines when the prediction was generated. </p>"
           }
         }
       }
@@ -4119,6 +4119,9 @@
     },
     "com.amazonaws.frauddetector#GetKMSEncryptionKey": {
       "type": "operation",
+      "input": {
+        "target": "smithy.api#Unit"
+      },
       "output": {
         "target": "com.amazonaws.frauddetector#GetKMSEncryptionKeyResult"
       },
@@ -7120,7 +7123,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Updates the status of a model version.</p>\n         <p>You can perform the following status updates:</p> \n         <ol>\n            <li>\n               <p>Change the <code>TRAINING_COMPLETE</code> status to <code>ACTIVE</code>.</p>\n            </li>\n            <li>\n               <p>Change <code>ACTIVE</code> to <code>INACTIVE</code>.</p>\n            </li>\n         </ol>"
+        "smithy.api#documentation": "<p>Updates the status of a model version.</p>\n         <p>You can perform the following status updates:</p> \n         <ol>\n            <li>\n               <p>Change the <code>TRAINING_IN_PROGRESS</code> status to <code>TRAINING_CANCELLED</code>.</p>\n            </li>\n            <li>\n               <p>Change the <code>TRAINING_COMPLETE</code> status to <code>ACTIVE</code>.</p>\n            </li>\n            <li>\n               <p>Change <code>ACTIVE</code> to <code>INACTIVE</code>.</p>\n            </li>\n         </ol>"
       }
     },
     "com.amazonaws.frauddetector#UpdateModelVersionStatusRequest": {