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 . alexaforbusiness ]

update-contact

Description

Updates the contact details by the contact ARN.

See also: AWS API Documentation

Synopsis

  update-contact
--contact-arn <value>
[--display-name <value>]
[--first-name <value>]
[--last-name <value>]
[--phone-number <value>]
[--phone-numbers <value>]
[--sip-addresses <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

--contact-arn (string)

The ARN of the contact to update.

--display-name (string)

The updated display name of the contact.

--first-name (string)

The updated first name of the contact.

--last-name (string)

The updated last name of the contact.

--phone-number (string)

The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

--phone-numbers (list)

The list of phone numbers for the contact.

(structure)

The phone number for the contact containing the raw number and phone number type.

Number -> (string)

The raw value of the phone number.

Type -> (string)

The type of the phone number.

Shorthand Syntax:

Number=string,Type=string ...

JSON Syntax:

[
  {
    "Number": "string",
    "Type": "MOBILE"|"WORK"|"HOME"
  }
  ...
]

--sip-addresses (list)

The list of SIP addresses for the contact.

(structure)

The SIP address for the contact containing the URI and SIP address type.

Uri -> (string)

The URI for the SIP address.

Type -> (string)

The type of the SIP address.

Shorthand Syntax:

Uri=string,Type=string ...

JSON Syntax:

[
  {
    "Uri": "string",
    "Type": "WORK"
  }
  ...
]

--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

None