[ aws . chime ]

validate-e911-address

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  validate-e911-address
--aws-account-id <value>
--street-number <value>
--street-info <value>
--city <value>
--state <value>
--country <value>
--postal-code <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The AWS account ID.

--street-number (string)

The address street number, such as 200 or 2121 .

--street-info (string)

The address street information, such as 8th Avenue .

--city (string)

The address city, such as Portland .

--state (string)

The address state, such as ME .

--country (string)

The address country, such as US .

--postal-code (string)

The address postal code, such as 04352 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

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 -> (structure)

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.

(structure)

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.