Amazonka.Chime.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.

Creating a Request

data ValidateE911Address

See: newValidateE911Address smart constructor.

Constructors

ValidateE911Address'

Fields

• awsAccountId :: Text

  The AWS account ID.

• streetNumber :: Sensitive Text

  The address street number, such as 200 or 2121.

• streetInfo :: Sensitive Text

  The address street information, such as 8th Avenue.

• city :: Sensitive Text

  The address city, such as Portland.

• state :: Sensitive Text

  The address state, such as ME.

• country :: Sensitive Text

  The address country, such as US.

• postalCode :: Sensitive Text

  The address postal code, such as 04352.

Instances

ToJSON ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

toJSON :: ValidateE911Address -> Value

toEncoding :: ValidateE911Address -> Encoding

toJSONList :: [ValidateE911Address] -> Value

toEncodingList :: [ValidateE911Address] -> Encoding

ToHeaders ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

toHeaders :: ValidateE911Address -> [Header]

ToPath ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

toPath :: ValidateE911Address -> ByteString

ToQuery ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

toQuery :: ValidateE911Address -> QueryString

AWSRequest ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Associated Types

type AWSResponse ValidateE911Address

Methods

request :: (Service -> Service) -> ValidateE911Address -> Request ValidateE911Address

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ValidateE911Address -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ValidateE911Address)))

Generic ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Associated Types

type Rep ValidateE911Address :: Type -> Type

Methods

from :: ValidateE911Address -> Rep ValidateE911Address x

to :: Rep ValidateE911Address x -> ValidateE911Address

Show ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

showsPrec :: Int -> ValidateE911Address -> ShowS

show :: ValidateE911Address -> String

showList :: [ValidateE911Address] -> ShowS

NFData ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

rnf :: ValidateE911Address -> ()

Eq ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

(==) :: ValidateE911Address -> ValidateE911Address -> Bool

(/=) :: ValidateE911Address -> ValidateE911Address -> Bool

Hashable ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

Methods

hashWithSalt :: Int -> ValidateE911Address -> Int

hash :: ValidateE911Address -> Int

type AWSResponse ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

type AWSResponse ValidateE911Address = ValidateE911AddressResponse

type Rep ValidateE911Address

Defined in Amazonka.Chime.ValidateE911Address

type Rep ValidateE911Address = D1 ('MetaData "ValidateE911Address" "Amazonka.Chime.ValidateE911Address" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ValidateE911Address'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "streetNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "streetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) :*: ((S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :*: (S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newValidateE911Address

Arguments

:: Text

ValidateE911Address

-> Text

ValidateE911Address

-> Text

ValidateE911Address

-> Text

ValidateE911Address

-> Text

ValidateE911Address

-> Text

ValidateE911Address

-> Text

ValidateE911Address

-> ValidateE911Address

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

The AWS account ID.

validateE911Address_streetNumber :: Lens' ValidateE911Address Text

The address street number, such as 200 or 2121.

validateE911Address_streetInfo :: Lens' ValidateE911Address Text

The address street information, such as 8th Avenue.

validateE911Address_city :: Lens' ValidateE911Address Text

The address city, such as Portland.

validateE911Address_state :: Lens' ValidateE911Address Text

The address state, such as ME.

validateE911Address_country :: Lens' ValidateE911Address Text

The address country, such as US.

validateE911Address_postalCode :: Lens' ValidateE911Address Text

The address postal code, such as 04352.

Destructuring the Response

data ValidateE911AddressResponse

See: newValidateE911AddressResponse smart constructor.

Constructors

ValidateE911AddressResponse'

Fields

• address :: Maybe Address

  The validated address.

• addressExternalId :: Maybe Text

  The ID that represents the address.

• candidateAddressList :: Maybe [CandidateAddress]

  The list of address suggestions.

• validationResult :: Maybe Natural

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ValidateE911AddressResponse

Defined in Amazonka.Chime.ValidateE911Address

Associated Types

type Rep ValidateE911AddressResponse :: Type -> Type

Methods

from :: ValidateE911AddressResponse -> Rep ValidateE911AddressResponse x

to :: Rep ValidateE911AddressResponse x -> ValidateE911AddressResponse

Show ValidateE911AddressResponse

Defined in Amazonka.Chime.ValidateE911Address

Methods

showsPrec :: Int -> ValidateE911AddressResponse -> ShowS

show :: ValidateE911AddressResponse -> String

showList :: [ValidateE911AddressResponse] -> ShowS

NFData ValidateE911AddressResponse

Defined in Amazonka.Chime.ValidateE911Address

Methods

rnf :: ValidateE911AddressResponse -> ()

Eq ValidateE911AddressResponse

Defined in Amazonka.Chime.ValidateE911Address

Methods

(==) :: ValidateE911AddressResponse -> ValidateE911AddressResponse -> Bool

(/=) :: ValidateE911AddressResponse -> ValidateE911AddressResponse -> Bool

type Rep ValidateE911AddressResponse

Defined in Amazonka.Chime.ValidateE911Address

type Rep ValidateE911AddressResponse = D1 ('MetaData "ValidateE911AddressResponse" "Amazonka.Chime.ValidateE911Address" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ValidateE911AddressResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Address)) :*: S1 ('MetaSel ('Just "addressExternalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "candidateAddressList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CandidateAddress])) :*: (S1 ('MetaSel ('Just "validationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newValidateE911AddressResponse

Arguments

:: Int

$sel:httpStatus:ValidateE911AddressResponse'

-> ValidateE911AddressResponse

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)

The validated address.

validateE911AddressResponse_addressExternalId :: Lens' ValidateE911AddressResponse (Maybe Text)

The ID that represents the address.

validateE911AddressResponse_candidateAddressList :: Lens' ValidateE911AddressResponse (Maybe [CandidateAddress])

The list of address suggestions.

validateE911AddressResponse_validationResult :: Lens' ValidateE911AddressResponse (Maybe Natural)

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

The response's http status code.