Chime / Client / validate_e911_address

validate_e911_address#

Chime.Client.validate_e911_address(**kwargs)#

Validates an address to be used for 911 calls made with Amazon Chime 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.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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 address country, such as US.

  • PostalCode (string) –

    [REQUIRED]

    The address postal code, such as 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. 0 means the address was perfect as is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

    • 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 a candidate address

        • streetNumber (string) –

          The numeric portion of a candidate address.

        • city (string) –

          The city of a candidate address.

        • state (string) –

          The state of a candidate address.

        • postalCode (string) –

          The postal code of a candidate address.

        • postalCodePlus4 (string) –

          The Zip + 4 or postal code + 4 of a candidate address.

        • country (string) –

          The country of a candidate address.

Exceptions