docs(client-chime-sdk-voice): Documentation-only update that clarifie…

…s the ValidateE911Address action of the Amazon Chime SDK Voice APIs.
aws · Sep 10, 2024 · 7ec26a0 · 7ec26a0
1 parent a0eda25
commit 7ec26a0
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 11 deletions.
diff --git a/clients/client-chime-sdk-voice/src/models/models_0.ts b/clients/client-chime-sdk-voice/src/models/models_0.ts
@@ -2901,7 +2901,7 @@ export interface GetVoiceConnectorStreamingConfigurationRequest {
  */
 export interface MediaInsightsConfiguration {
   /**
-   * <p>Denotes the configration as enabled or disabled.</p>
+   * <p>Denotes the configuration as enabled or disabled.</p>
    * @public
    */
   Disabled?: boolean;
@@ -3136,7 +3136,7 @@ export interface GetVoiceToneAnalysisTaskRequest {
   VoiceConnectorId: string | undefined;
 
   /**
-   * <p>The ID of the voice tone anlysis task.</p>
+   * <p>The ID of the voice tone analysis task.</p>
    * @public
    */
   VoiceToneAnalysisTaskId: string | undefined;
@@ -4680,7 +4680,9 @@ export interface ValidateE911AddressRequest {
   State: string | undefined;
 
   /**
-   * <p>The country in the address being validated.</p>
+   * <p>The country in the address being validated as two-letter country code in ISO 3166-1
+   *          alpha-2 format, such as <code>US</code>. For more information, see <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a> in
+   *          Wikipedia.</p>
    * @public
    */
   Country: string | undefined;
@@ -4697,10 +4699,25 @@ export interface ValidateE911AddressRequest {
  */
 export interface ValidateE911AddressResponse {
   /**
-   * <p>Number indicating the result of address validation. <code>0</code> means the
-   *          address was perfect as-is and successfully validated. <code>1</code> means the
-   *          address was corrected. <code>2</code> means the address sent was not close
-   *          enough and was not validated.</p>
+   * <p>Number indicating the result of address validation.</p>
+   *          <p>Each possible result is defined as follows:</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>0</code> - Address validation succeeded.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>1</code> - Address validation succeeded. The address was a close enough
+   *                match and has been corrected as part of the address object.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>2</code> - Address validation failed. You should re-submit the validation
+   *                request with candidates from the <code>CandidateAddressList</code> result, if it's a
+   *                close match.</p>
+   *             </li>
+   *          </ul>
    * @public
    */
   ValidationResult?: number;

diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-voice.json b/codegen/sdk-codegen/aws-models/chime-sdk-voice.json
@@ -5309,7 +5309,7 @@
         "VoiceToneAnalysisTaskId": {
           "target": "com.amazonaws.chimesdkvoice#NonEmptyString256",
           "traits": {
-            "smithy.api#documentation": "<p>The ID of the voice tone anlysis task.</p>",
+            "smithy.api#documentation": "<p>The ID of the voice tone analysis task.</p>",
             "smithy.api#httpLabel": {},
             "smithy.api#required": {}
           }
@@ -6495,7 +6495,7 @@
         "Disabled": {
           "target": "com.amazonaws.chimesdkvoice#Boolean",
           "traits": {
-            "smithy.api#documentation": "<p>Denotes the configration as enabled or disabled.</p>"
+            "smithy.api#documentation": "<p>Denotes the configuration as enabled or disabled.</p>"
           }
         },
         "ConfigurationArn": {
@@ -10687,7 +10687,7 @@
         "Country": {
           "target": "com.amazonaws.chimesdkvoice#SensitiveNonEmptyString",
           "traits": {
-            "smithy.api#documentation": "<p>The country in the address being validated.</p>",
+            "smithy.api#documentation": "<p>The country in the address being validated as two-letter country code in ISO 3166-1\n         alpha-2 format, such as <code>US</code>. For more information, see <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a> in\n         Wikipedia.</p>",
             "smithy.api#required": {}
           }
         },
@@ -10710,7 +10710,7 @@
           "target": "com.amazonaws.chimesdkvoice#ValidationResult",
           "traits": {
             "smithy.api#default": 0,
-            "smithy.api#documentation": "<p>Number indicating the result of address validation. <code>0</code> means the \n         address was perfect as-is and successfully validated. <code>1</code> means the \n         address was corrected. <code>2</code> means the address sent was not close \n         enough and was not validated.</p>"
+            "smithy.api#documentation": "<p>Number indicating the result of address validation.</p>\n         <p>Each possible result is defined as follows:</p>\n         <ul>\n            <li>\n               <p>\n                  <code>0</code> - Address validation succeeded.</p>\n            </li>\n            <li>\n               <p>\n                  <code>1</code> - Address validation succeeded. The address was a close enough\n               match and has been corrected as part of the address object.</p>\n            </li>\n            <li>\n               <p>\n                  <code>2</code> - Address validation failed. You should re-submit the validation\n               request with candidates from the <code>CandidateAddressList</code> result, if it's a\n               close match.</p>\n            </li>\n         </ul>"
           }
         },
         "AddressExternalId": {