Skip to content

ValidateE911AddressResponse

Source code in docs_src/capo_chime_sdk_voice/types/validate_e911_address_response.py 
14
15
16
17
18
19
20
21
22
23
24
class ValidateE911AddressResponse(TypedDict, closed=True):
    validation_result: "capo_chime_sdk_voice.types.validation_result.ValidationResult"
    """<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>"""
    address_external_id: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>The ID that represents the address.</p>"""
    address: NotRequired["capo_chime_sdk_voice.types.address.Address"]
    """<p>The validated address.</p>"""
    candidate_address_list: NotRequired[
        "capo_chime_sdk_voice.types.candidate_address_list.CandidateAddressList"
    ]
    """<p>The list of address suggestions..</p>"""

address instance-attribute 

address: NotRequired[Address]

The validated address.

address_external_id instance-attribute 

address_external_id: NotRequired[String]

The ID that represents the address.

candidate_address_list instance-attribute 

candidate_address_list: NotRequired[CandidateAddressList]

The list of address suggestions..

validation_result instance-attribute 

validation_result: ValidationResult

Number indicating the result of address validation.

Each possible result is defined as follows:

  • 0 - Address validation succeeded.

  • 1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.

  • 2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.