Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data ValidateE911Address = ValidateE911Address' {}
- newValidateE911Address :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> ValidateE911Address
- validateE911Address_awsAccountId :: Lens' ValidateE911Address Text
- validateE911Address_streetNumber :: Lens' ValidateE911Address Text
- validateE911Address_streetInfo :: Lens' ValidateE911Address Text
- validateE911Address_city :: Lens' ValidateE911Address Text
- validateE911Address_state :: Lens' ValidateE911Address Text
- validateE911Address_country :: Lens' ValidateE911Address Text
- validateE911Address_postalCode :: Lens' ValidateE911Address Text
- data ValidateE911AddressResponse = ValidateE911AddressResponse' {}
- newValidateE911AddressResponse :: Int -> ValidateE911AddressResponse
- validateE911AddressResponse_address :: Lens' ValidateE911AddressResponse (Maybe Address)
- validateE911AddressResponse_addressExternalId :: Lens' ValidateE911AddressResponse (Maybe Text)
- validateE911AddressResponse_candidateAddressList :: Lens' ValidateE911AddressResponse (Maybe [CandidateAddress])
- validateE911AddressResponse_validationResult :: Lens' ValidateE911AddressResponse (Maybe Natural)
- validateE911AddressResponse_httpStatus :: Lens' ValidateE911AddressResponse Int
Creating a Request
data ValidateE911Address Source #
See: newValidateE911Address
smart constructor.
ValidateE911Address' | |
|
Instances
newValidateE911Address Source #
Create a value of ValidateE911Address
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ValidateE911Address
, validateE911Address_awsAccountId
- The AWS account ID.
ValidateE911Address
, validateE911Address_streetNumber
- The address street number, such as 200
or 2121
.
ValidateE911Address
, validateE911Address_streetInfo
- The address street information, such as 8th Avenue
.
ValidateE911Address
, validateE911Address_city
- The address city, such as Portland
.
ValidateE911Address
, validateE911Address_state
- The address state, such as ME
.
ValidateE911Address
, validateE911Address_country
- The address country, such as US
.
ValidateE911Address
, validateE911Address_postalCode
- The address postal code, such as 04352
.
Request Lenses
validateE911Address_awsAccountId :: Lens' ValidateE911Address Text Source #
The AWS account ID.
validateE911Address_streetNumber :: Lens' ValidateE911Address Text Source #
The address street number, such as 200
or 2121
.
validateE911Address_streetInfo :: Lens' ValidateE911Address Text Source #
The address street information, such as 8th Avenue
.
validateE911Address_city :: Lens' ValidateE911Address Text Source #
The address city, such as Portland
.
validateE911Address_state :: Lens' ValidateE911Address Text Source #
The address state, such as ME
.
validateE911Address_country :: Lens' ValidateE911Address Text Source #
The address country, such as US
.
validateE911Address_postalCode :: Lens' ValidateE911Address Text Source #
The address postal code, such as 04352
.
Destructuring the Response
data ValidateE911AddressResponse Source #
See: newValidateE911AddressResponse
smart constructor.
ValidateE911AddressResponse' | |
|
Instances
newValidateE911AddressResponse Source #
Create a value of ValidateE911AddressResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:ValidateE911AddressResponse'
, validateE911AddressResponse_address
- The validated address.
$sel:addressExternalId:ValidateE911AddressResponse'
, validateE911AddressResponse_addressExternalId
- The ID that represents the address.
$sel:candidateAddressList:ValidateE911AddressResponse'
, validateE911AddressResponse_candidateAddressList
- The list of address suggestions.
$sel:validationResult:ValidateE911AddressResponse'
, validateE911AddressResponse_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.
$sel:httpStatus:ValidateE911AddressResponse'
, validateE911AddressResponse_httpStatus
- The response's http status code.
Response Lenses
validateE911AddressResponse_address :: Lens' ValidateE911AddressResponse (Maybe Address) Source #
The validated address.
validateE911AddressResponse_addressExternalId :: Lens' ValidateE911AddressResponse (Maybe Text) Source #
The ID that represents the address.
validateE911AddressResponse_candidateAddressList :: Lens' ValidateE911AddressResponse (Maybe [CandidateAddress]) Source #
The list of address suggestions.
validateE911AddressResponse_validationResult :: Lens' ValidateE911AddressResponse (Maybe Natural) Source #
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.
validateE911AddressResponse_httpStatus :: Lens' ValidateE911AddressResponse Int Source #
The response's http status code.