ChimeSDKVoice / Client / validate_e911_address

validate_e911_address#

ChimeSDKVoice.Client.validate_e911_address(**kwargs)#

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

See also: AWS API Documentation

Request Syntax

response = client.validate_e911_address(
    AwsAccountId='string',
    StreetNumber='string',
    StreetInfo='string',
    City='string',
    State='string',
    Country='string',
    PostalCode='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The AWS account ID.

  • StreetNumber (string) –

    [REQUIRED]

    The address street number, such as 200 or 2121.

  • StreetInfo (string) –

    [REQUIRED]

    The address street information, such as 8th Avenue.

  • City (string) –

    [REQUIRED]

    The address city, such as Portland.

  • State (string) –

    [REQUIRED]

    The address state, such as ME.

  • Country (string) –

    [REQUIRED]

    The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.

  • PostalCode (string) –

    [REQUIRED]

    The dress postal code, such 04352.

Return type:

dict

Returns:

Response Syntax

{
    'ValidationResult': 123,
    'AddressExternalId': 'string',
    'Address': {
        'streetName': 'string',
        'streetSuffix': 'string',
        'postDirectional': 'string',
        'preDirectional': 'string',
        'streetNumber': 'string',
        'city': 'string',
        'state': 'string',
        'postalCode': 'string',
        'postalCodePlus4': 'string',
        'country': 'string'
    },
    'CandidateAddressList': [
        {
            'streetInfo': 'string',
            'streetNumber': 'string',
            'city': 'string',
            'state': 'string',
            'postalCode': 'string',
            'postalCodePlus4': 'string',
            'country': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ValidationResult (integer) –

      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.

    • AddressExternalId (string) –

      The ID that represents the address.

    • Address (dict) –

      The validated address.

      • streetName (string) –

        The address street, such as 8th Avenue.

      • streetSuffix (string) –

        The address suffix, such as the N in 8th Avenue N.

      • postDirectional (string) –

        An address suffix location, such as the S. Unit A in Central Park S. Unit A.

      • preDirectional (string) –

        An address prefix location, such as the N in N. Third St.

      • streetNumber (string) –

        The numeric portion of an address.

      • city (string) –

        The city of an address.

      • state (string) –

        The state of an address.

      • postalCode (string) –

        The postal code of an address.

      • postalCodePlus4 (string) –

        The zip + 4 or postal code + 4 of an address.

      • country (string) –

        The country of an address.

    • CandidateAddressList (list) –

      The list of address suggestions..

      • (dict) –

        A suggested address.

        • streetInfo (string) –

          The street information of the candidate address.

        • streetNumber (string) –

          The numeric portion of the candidate address.

        • city (string) –

          The city of the candidate address.

        • state (string) –

          The state of the candidate address.

        • postalCode (string) –

          The postal code of the candidate address.

        • postalCodePlus4 (string) –

          The zip + 4 or postal code +4 of the candidate address.

        • country (string) –

          The country of the candidate address.

Exceptions