ValidateE911Address - Amazon Chime SDK

ValidateE911Address

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.

Request Syntax

POST /emergency-calling/address HTTP/1.1 Content-type: application/json { "AwsAccountId": "string", "City": "string", "Country": "string", "PostalCode": "string", "State": "string", "StreetInfo": "string", "StreetNumber": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AwsAccountId

The AWS account ID.

Type: String

Pattern: .*\S.*

Required: Yes

City

The address city, such as Portland.

Type: String

Pattern: .*\S.*

Required: Yes

Country

The address country, such as US.

Type: String

Pattern: .*\S.*

Required: Yes

PostalCode

The address postal code, such as 04352.

Type: String

Pattern: .*\S.*

Required: Yes

State

The address state, such as ME.

Type: String

Pattern: .*\S.*

Required: Yes

StreetInfo

The address street information, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: Yes

StreetNumber

The address street number, such as 200 or 2121.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax

HTTP/1.1 202 Content-type: application/json { "Address": { "city": "string", "country": "string", "postalCode": "string", "postalCodePlus4": "string", "postDirectional": "string", "preDirectional": "string", "state": "string", "streetName": "string", "streetNumber": "string", "streetSuffix": "string" }, "AddressExternalId": "string", "CandidateAddressList": [ { "city": "string", "country": "string", "postalCode": "string", "postalCodePlus4": "string", "state": "string", "streetInfo": "string", "streetNumber": "string" } ], "ValidationResult": number }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

Address

The validated address.

Type: Address object

AddressExternalId

The ID that represents the address.

Type: String

CandidateAddressList

The list of address suggestions.

Type: Array of CandidateAddress objects

ValidationResult

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: