[ aws . alexaforbusiness ]

update-contact

Description

Updates the contact details by the contact ARN.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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 | --cli-input-yaml]
[--generate-cli-skeleton <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 | --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.

See ‘aws help’ for descriptions of global parameters.

Output

None