Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.