Skip to content

Commit 7ec26a0

Browse files
author
awstools
committed
docs(client-chime-sdk-voice): Documentation-only update that clarifies the ValidateE911Address action of the Amazon Chime SDK Voice APIs.
1 parent a0eda25 commit 7ec26a0

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

Diff for: clients/client-chime-sdk-voice/src/models/models_0.ts

+24-7
Original file line numberDiff line numberDiff line change
@@ -2901,7 +2901,7 @@ export interface GetVoiceConnectorStreamingConfigurationRequest {
29012901
*/
29022902
export interface MediaInsightsConfiguration {
29032903
/**
2904-
* <p>Denotes the configration as enabled or disabled.</p>
2904+
* <p>Denotes the configuration as enabled or disabled.</p>
29052905
* @public
29062906
*/
29072907
Disabled?: boolean;
@@ -3136,7 +3136,7 @@ export interface GetVoiceToneAnalysisTaskRequest {
31363136
VoiceConnectorId: string | undefined;
31373137

31383138
/**
3139-
* <p>The ID of the voice tone anlysis task.</p>
3139+
* <p>The ID of the voice tone analysis task.</p>
31403140
* @public
31413141
*/
31423142
VoiceToneAnalysisTaskId: string | undefined;
@@ -4680,7 +4680,9 @@ export interface ValidateE911AddressRequest {
46804680
State: string | undefined;
46814681

46824682
/**
4683-
* <p>The country in the address being validated.</p>
4683+
* <p>The country in the address being validated as two-letter country code in ISO 3166-1
4684+
* 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
4685+
* Wikipedia.</p>
46844686
* @public
46854687
*/
46864688
Country: string | undefined;
@@ -4697,10 +4699,25 @@ export interface ValidateE911AddressRequest {
46974699
*/
46984700
export interface ValidateE911AddressResponse {
46994701
/**
4700-
* <p>Number indicating the result of address validation. <code>0</code> means the
4701-
* address was perfect as-is and successfully validated. <code>1</code> means the
4702-
* address was corrected. <code>2</code> means the address sent was not close
4703-
* enough and was not validated.</p>
4702+
* <p>Number indicating the result of address validation.</p>
4703+
* <p>Each possible result is defined as follows:</p>
4704+
* <ul>
4705+
* <li>
4706+
* <p>
4707+
* <code>0</code> - Address validation succeeded.</p>
4708+
* </li>
4709+
* <li>
4710+
* <p>
4711+
* <code>1</code> - Address validation succeeded. The address was a close enough
4712+
* match and has been corrected as part of the address object.</p>
4713+
* </li>
4714+
* <li>
4715+
* <p>
4716+
* <code>2</code> - Address validation failed. You should re-submit the validation
4717+
* request with candidates from the <code>CandidateAddressList</code> result, if it's a
4718+
* close match.</p>
4719+
* </li>
4720+
* </ul>
47044721
* @public
47054722
*/
47064723
ValidationResult?: number;

Diff for: codegen/sdk-codegen/aws-models/chime-sdk-voice.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -5309,7 +5309,7 @@
53095309
"VoiceToneAnalysisTaskId": {
53105310
"target": "com.amazonaws.chimesdkvoice#NonEmptyString256",
53115311
"traits": {
5312-
"smithy.api#documentation": "<p>The ID of the voice tone anlysis task.</p>",
5312+
"smithy.api#documentation": "<p>The ID of the voice tone analysis task.</p>",
53135313
"smithy.api#httpLabel": {},
53145314
"smithy.api#required": {}
53155315
}
@@ -6495,7 +6495,7 @@
64956495
"Disabled": {
64966496
"target": "com.amazonaws.chimesdkvoice#Boolean",
64976497
"traits": {
6498-
"smithy.api#documentation": "<p>Denotes the configration as enabled or disabled.</p>"
6498+
"smithy.api#documentation": "<p>Denotes the configuration as enabled or disabled.</p>"
64996499
}
65006500
},
65016501
"ConfigurationArn": {
@@ -10687,7 +10687,7 @@
1068710687
"Country": {
1068810688
"target": "com.amazonaws.chimesdkvoice#SensitiveNonEmptyString",
1068910689
"traits": {
10690-
"smithy.api#documentation": "<p>The country in the address being validated.</p>",
10690+
"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>",
1069110691
"smithy.api#required": {}
1069210692
}
1069310693
},
@@ -10710,7 +10710,7 @@
1071010710
"target": "com.amazonaws.chimesdkvoice#ValidationResult",
1071110711
"traits": {
1071210712
"smithy.api#default": 0,
10713-
"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>"
10713+
"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>"
1071410714
}
1071510715
},
1071610716
"AddressExternalId": {

0 commit comments

Comments
 (0)